add entity id property (#3016)

* add entity id property * review * rename to parentIdProperty * review
coda · Jul 9, 2024 · cc3c772 · cc3c772
1 parent 38bbde8
commit cc3c772
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 6 deletions.
diff --git a/dist/bundle.d.ts b/dist/bundle.d.ts
diff --git a/dist/bundle.js b/dist/bundle.js
diff --git a/dist/helpers/migration.js b/dist/helpers/migration.js
diff --git a/dist/schema.d.ts b/dist/schema.d.ts
diff --git a/dist/schema.js b/dist/schema.js
diff --git a/dist/testing/upload_validation.js b/dist/testing/upload_validation.js
diff --git a/helpers/migration.ts b/helpers/migration.ts
@@ -60,6 +60,7 @@ class ObjectSchemaHelper<T extends ObjectSchemaDefinition<string, string>> {
       groupIdProperty,
       bodyTextProperty,
       popularityRankProperty,
+      parentIdProperty,
 
       ...rest
     } = schema;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@codahq/packs-sdk",
-  "version": "1.7.8-prerelease.1",
+  "version": "1.7.8-prerelease.2",
   "license": "MIT",
   "workspaces": [
     "dev/eslint"

diff --git a/schema.ts b/schema.ts
@@ -1247,6 +1247,16 @@ export interface ObjectSchemaDefinition<K extends string, L extends string>
    * @hidden
    */
   groupIdProperty?: PropertyIdentifier<K>;
+  /**
+   * The name of a property within {@link ObjectSchemaDefinition.properties} that represents a unique id for a
+   * parent entity for the object. It is recommended for sync table schemas with a bodyTextProperty to specify an
+   * a parentIdProperty, which uniquely identifies the entity that groups 1 to multiple rows. Note though that
+   * specifying a bodyTextProperty does not necessarily require it to be chunked into multiple rows. But if it is,
+   * a sync table where each row is a partial chunk of a larger document may want to specify a parent id that
+   * represents the document, while each row's id can be unique to the chunk.
+   * @hidden
+   */
+  parentIdProperty?: K;
 
   /**
    * The name of the property within {@link ObjectSchemaDefinition.properties} that can be be interpreted as
@@ -1884,6 +1894,7 @@ export function normalizeObjectSchema(schema: GenericObjectSchema): GenericObjec
     id,
     identity,
     idProperty,
+    parentIdProperty,
     imageProperty,
     includeUnknownProperties,
     linkProperty,
@@ -1937,6 +1948,7 @@ export function normalizeObjectSchema(schema: GenericObjectSchema): GenericObjec
     id: id ? normalizeSchemaKey(id) : undefined,
     identity,
     idProperty: idProperty ? normalizeSchemaKey(idProperty) : undefined,
+    parentIdProperty: parentIdProperty ? normalizeSchemaKey(parentIdProperty) : undefined,
     imageProperty: imageProperty ? normalizeSchemaPropertyIdentifier(imageProperty, normalizedProperties) : undefined,
     includeUnknownProperties,
     linkProperty: linkProperty ? normalizeSchemaPropertyIdentifier(linkProperty, normalizedProperties) : undefined,

diff --git a/testing/upload_validation.ts b/testing/upload_validation.ts
@@ -1159,6 +1159,7 @@ function buildMetadataSchema({sdkVersion}: BuildMetadataSchemaArgs): {
       description: z.string().optional(),
       id: z.string().min(1).optional(),
       idProperty: z.string().min(1).optional(),
+      parentIdProperty: z.string().min(1).optional(),
       primary: z.string().min(1).optional(),
       displayProperty: z.string().min(1).optional(),
       codaType: z.enum([...ObjectHintValueTypes]).optional(),
@@ -1232,6 +1233,14 @@ function buildMetadataSchema({sdkVersion}: BuildMetadataSchemaArgs): {
           message: 'The "idProperty" property must appear as a key in the "properties" object.',
         },
       )
+      .refine(
+        data => {
+          return isNil(data.parentIdProperty) || data.parentIdProperty in data.properties;
+        },
+        {
+          message: 'The "parentIdProperty" property must appear as a key in the "properties" object.',
+        },
+      )
       .refine(
         data => {
           const schemaHelper = objectSchemaHelper(data as GenericObjectSchema);