native: use channel.meta to store custom channel config on API

apps/tlon-mobile/ios/Podfile.lock

@@ -1905,4 +1905,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 0cb7a78e5777e69c86c1bf4bb5135fd660376dbe
 
-COCOAPODS: 1.16.2
+COCOAPODS: 1.15.2

packages/app/features/settings/FeatureFlagScreen.tsx

@@ -29,7 +29,7 @@ export function FeatureFlagScreen({ navigation }: Props) {
       Object.entries(featureFlags.featureMeta)
         .filter(([name]) => {
           if (name === 'customChannelCreation') {
-            return isTlonEmployee;
+            return isTlonEmployee || __DEV__;
           }
           return true;
         })

packages/app/ui/components/ContactNameV2.tsx

@@ -50,12 +50,20 @@ export const useContactNameProps = ({
   ]);
 };
 
-export const useContactName = (options: string | ContactNameOptions) => {
+export function useContactName(options: string | ContactNameOptions): string;
+export function useContactName(
+  options: string | ContactNameOptions | null
+): string | null;
+export function useContactName(
+  options: string | ContactNameOptions | null
+): string | null {
   const resolvedOptions = useMemo(() => {
-    return typeof options === 'string' ? { contactId: options } : options;
+    return typeof options === 'string' || options == null
+      ? { contactId: options ?? '' }
+      : options;
   }, [options]);
   return useContactNameProps(resolvedOptions).children;
-};
+}
 
 const BaseContactName = RawText.styleable<{
   contactId: string;

packages/app/ui/components/postCollectionViews/shared.tsx

@@ -29,7 +29,7 @@ export function ConnectedPostView({
       return null;
     }
     return {
-      showAuthor: JSONValue.asBoolean(cfg.showAuthor, false),
+      showAuthor: JSONValue.asBoolean(cfg.showAuthors, false),
       showReplies: JSONValue.asBoolean(cfg.showReplies, false),
     };
   }, [ctx.collectionConfiguration]);

packages/app/ui/contexts/componentsKits.tsx

@@ -105,7 +105,7 @@ const BUILTIN_CONTENT_RENDERERS: { [id: string]: RenderItemType } = {
   [PostContentRendererId.audio]: AudioPost,
   [PostContentRendererId.color]: ColorPost,
   [PostContentRendererId.raw]: ({ post, contentRendererConfiguration }) => {
-    const contactName = useContactName(post.author!.id);
+    const contactName = useContactName(post.author?.id ?? null);
     return (
       <Text
         style={{

packages/shared/src/api/channelContentConfig.ts

@@ -1,4 +1,5 @@
 import type { JSONValue } from '../types/JSONValue';
+import { ChannelMetadata } from '../urbit';
 import { ValuesOf } from '../utils';
 
 interface BaseParameterSpec {
@@ -284,72 +285,47 @@ export namespace ChannelContentConfiguration {
   ): ParameterizedId<CollectionRendererId> {
     return ParameterizedId.coerce(configuration.defaultPostCollectionRenderer);
   }
-}
 
-/**
- * We use a channel's `description` field to store structured data. This
- * module provides helpers for managing that data.
- */
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export namespace StructuredChannelDescriptionPayload {
-  type Encoded = string | null | undefined;
-  interface Decoded {
-    channelContentConfiguration?: ChannelContentConfiguration;
-    description?: string;
-  }
+  export function toApiMeta(cfg: ChannelContentConfiguration): ChannelMetadata {
+    return {
+      version: 1,
 
-  export function encode(payload: Decoded): Encoded {
-    return JSON.stringify(payload);
-  }
+      postInput: ((x) => ({
+        postType: x.id,
 
-  /**
-   * Attempts to decode a `description` string into a structured payload.
-   *
-   * - If `description` is null/undefined, returns a payload with no
-   *   description nor configuration.
-   * - If `description` is not valid JSON, returns a payload with the
-   *   description as the input string.
-   * - If `description` validates as the expected
-   *   `StructuredChannelDescriptionPayload` JSON, returns the decoded payload.
-   */
-  export function decode(encoded: Encoded): Decoded {
-    // TODO: This should be validated - we'll be deserializing untrusted data
-    if (encoded == null) {
-      return {};
-    }
-    try {
-      const out = JSON.parse(encoded);
-      if ('channelContentConfiguration' in out) {
-        if (typeof out.channelContentConfiguration !== 'object') {
-          throw new Error('Invalid configuration');
-        }
-        // add a little robustness - if the configuration is missing a field,
-        // just add a default in to avoid crashing
-        out.channelContentConfiguration = ((raw) => {
-          const cfg = {
-            draftInput: DraftInputId.chat,
-            defaultPostContentRenderer: PostContentRendererId.chat,
-            defaultPostCollectionRenderer: CollectionRendererId.chat,
-            ...raw,
-          } as ChannelContentConfiguration;
+        type: x.id,
+        configuration: x.configuration,
+      }))(ChannelContentConfiguration.draftInput(cfg)),
 
-          // add defaults to some standard params
-          const collCfgWithDefaults = ParameterizedId.coerce(
-            cfg.defaultPostCollectionRenderer
-          );
-          collCfgWithDefaults.configuration = {
-            showAuthors: true,
-            showReplies: true,
-            ...collCfgWithDefaults.configuration,
-          };
+      postCollectionRenderer: ((x) => ({
+        id: x.id,
+        configuration: x.configuration,
+      }))(ChannelContentConfiguration.defaultPostCollectionRenderer(cfg)),
 
-          return cfg;
-        })(out.channelContentConfiguration);
-      }
-      return out;
-    } catch (_err) {
-      return { description: encoded.length === 0 ? undefined : encoded };
-    }
+      defaultContentRenderer: ((x) => ({
+        rendererId: x.id,
+        configuration: x.configuration,
+      }))(ChannelContentConfiguration.defaultPostContentRenderer(cfg)),
+    };
+  }
+
+  export function fromApiMeta(
+    meta: ChannelMetadata
+  ): ChannelContentConfiguration {
+    return {
+      draftInput: {
+        id: meta.postInput.type as DraftInputId,
+        configuration: meta.postInput.configuration,
+      },
+      defaultPostContentRenderer: {
+        id: meta.defaultContentRenderer.rendererId as PostContentRendererId,
+        configuration: meta.defaultContentRenderer.configuration,
+      },
+      defaultPostCollectionRenderer: {
+        id: meta.postCollectionRenderer.id as CollectionRendererId,
+        configuration: meta.postCollectionRenderer.configuration,
+      },
+    };
   }
 }
 

packages/shared/src/api/channelsApi.ts

@@ -91,7 +91,8 @@ export type MarkChannelReadUpdate = {
 
 export type MetaUpdate = {
   type: 'channelMetaUpdate';
-  meta: Stringified<ub.ChannelMetadataSchemaV1> | null;
+  meta: Stringified<ub.ChannelMetadata> | null;
+  channelId: string;
 };
 
 export type ChannelsUpdate =
@@ -129,14 +130,30 @@ export const createChannel = async ({
   );
 };
 
+export const setupChannelFromTemplate = async (
+  exampleChannelId: string,
+  targetChannelId: string
+) => {
+  return client.thread<string>({
+    desk: 'groups',
+    inputMark: 'hook-setup-template-args',
+    outputMark: 'json',
+    threadName: 'channel-setup-from-template',
+    body: {
+      example: exampleChannelId,
+      target: targetChannelId,
+    },
+  });
+};
+
 export async function updateChannelMeta(
   channelId: string,
-  metaPayload: Stringified<ub.ChannelMetadataSchemaV1> | null
+  metaPayload: Stringified<ub.ChannelMetadata> | null
 ) {
   return trackedPoke<ub.ChannelsResponse>(
     {
       app: 'channels',
-      mark: 'channel-action',
+      mark: 'channel-action-1',
       json: {
         channel: {
           nest: channelId,
@@ -153,22 +170,6 @@ export async function updateChannelMeta(
   );
 }
 
-export const setupChannelFromTemplate = async (
-  exampleChannelId: string,
-  targetChannelId: string
-) => {
-  return client.thread<string>({
-    desk: 'groups',
-    inputMark: 'hook-setup-template-args',
-    outputMark: 'json',
-    threadName: 'channel-setup-from-template',
-    body: {
-      example: exampleChannelId,
-      target: targetChannelId,
-    },
-  });
-};
-
 export const subscribeToChannelsUpdates = async (
   eventHandler: (update: ChannelsUpdate) => void
 ) => {
@@ -193,14 +194,20 @@ export type ChannelInit = {
   channelId: string;
   writers: string[];
   readers: string[];
+  meta: ub.ChannelMetadata | null;
 };
 
 export function toClientChannelInit(
   id: string,
   channel: ub.Channel,
   readers: string[]
 ): ChannelInit {
-  return { channelId: id, writers: channel.perms.writers ?? [], readers };
+  return {
+    channelId: id,
+    writers: channel.perms.writers ?? [],
+    readers,
+    meta: channel.meta,
+  };
 }
 
 export const toChannelsUpdate = (
@@ -240,6 +247,7 @@ export const toChannelsUpdate = (
       return {
         type: 'channelMetaUpdate',
         meta: channelEvent.response.meta,
+        channelId,
       };
     }
 

packages/shared/src/api/chatApi.ts

@@ -8,10 +8,6 @@ import {
   getCanonicalPostId,
   toClientMeta,
 } from './apiUtils';
-import {
-  ChannelContentConfiguration,
-  StructuredChannelDescriptionPayload,
-} from './channelContentConfig';
 import { toPostData, toPostReplyData, toReplyMeta } from './postsApi';
 import { getCurrentUserId, poke, scry, subscribe, trackedPoke } from './urbit';
 
@@ -339,21 +335,13 @@ export const toClientGroupDms = (groupDms: ub.Clubs): GetDmsResponse => {
 
       const metaFields = toClientMeta(club.meta);
 
-      // Channel meta is different from other metas, since we can overload the
-      // `description` to fit other channel-specific data.
-      // Attempt to decode that extra info here.
-      const decodedDesc = StructuredChannelDescriptionPayload.decode(
-        metaFields.description
-      );
-
       return {
         id,
         type: 'groupDm',
         ...metaFields,
         isDmInvite: !isJoined && isInvited,
         members: [...joinedMembers, ...invitedMembers],
-        contentConfiguration: decodedDesc.channelContentConfiguration,
-        description: decodedDesc.description,
+        description: metaFields.description,
       };
     })
     .filter(Boolean) as db.Channel[];

packages/shared/src/api/groupsApi.ts

@@ -13,7 +13,6 @@ import {
   getJoinStatusFromGang,
 } from '../urbit';
 import { parseGroupChannelId, parseGroupId, toClientMeta } from './apiUtils';
-import { StructuredChannelDescriptionPayload } from './channelContentConfig';
 import {
   getCurrentUserId,
   poke,
@@ -1640,9 +1639,6 @@ function toClientChannel({
   channel: ub.GroupChannel;
   groupId: string;
 }): db.Channel {
-  const { description, channelContentConfiguration } =
-    StructuredChannelDescriptionPayload.decode(channel.meta.description);
-
   const readerRoles = (channel.readers ?? []).map((roleId) => ({
     channelId: id,
     roleId,
@@ -1663,8 +1659,7 @@ function toClientChannel({
     iconImage: omitEmpty(channel.meta.image),
     title: omitEmpty(channel.meta.title),
     coverImage: omitEmpty(channel.meta.cover),
-    description,
-    contentConfiguration: channelContentConfiguration,
+    description: omitEmpty(channel.meta.description),
     currentUserIsHost: hostUserId === currentUserId,
     readerRoles,
     writerRoles,
@@ -1680,18 +1675,14 @@ function toClientChannelFromPreview({
   channel: ub.ChannelPreview;
   groupId: string;
 }): db.Channel {
-  const { description, channelContentConfiguration } =
-    StructuredChannelDescriptionPayload.decode(channel.meta.description);
-
   return {
     id,
     groupId,
     type: getChannelType(id),
     iconImage: omitEmpty(channel.meta.image),
     title: omitEmpty(channel.meta.title),
     coverImage: omitEmpty(channel.meta.cover),
-    description,
-    contentConfiguration: channelContentConfiguration,
+    description: omitEmpty(channel.meta.description),
   };
 }