Add itemVersionProperty for tracking item state in ingestions (#3100)

* add itemVersionProperty * update * update comment * update comment * update name * update name * update type
coda · Nov 8, 2024 · 426ded9 · 426ded9
1 parent 2d29301
commit 426ded9
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 7 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
@@ -62,6 +62,7 @@ class ObjectSchemaHelper<T extends ObjectSchemaDefinition<string, string>> {
       bodyTextProperty,
       popularityRankProperty,
       parentIdProperty,
+      versionProperty,
       index,
       ...rest
     } = schema;

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

diff --git a/schema.ts b/schema.ts
@@ -1070,6 +1070,7 @@ export type ObjectSchemaPathProperties = Pick<
   | 'memberGroupIdProperty'
   | 'bodyTextProperty'
   | 'popularityRankProperty'
+  | 'versionProperty'
 >;
 
 /**
@@ -1374,6 +1375,16 @@ export interface ObjectSchemaDefinition<K extends string, L extends string>
    */
   index?: IndexDefinition;
 
+  /**
+   * The name of the property within {@link ObjectSchemaDefinition.properties} that can be be interpreted as
+   * text representing the version of an item.
+   *
+   * Must be a {@link ValueType.String} property.
+   * TODO(ebo): Unhide this
+   * @hidden
+   */
+  versionProperty? : PropertyIdentifier<K>;
+
   // TODO(dweitzman): Only support options in the typing when the codaType is ValueHintType.SelectList.
 }
 
@@ -2112,6 +2123,7 @@ export function normalizeObjectSchema(schema: GenericObjectSchema): GenericObjec
     memberGroupIdProperty,
     bodyTextProperty,
     popularityRankProperty,
+    versionProperty,
     index,
     ...rest
   } = schema;
@@ -2189,6 +2201,9 @@ export function normalizeObjectSchema(schema: GenericObjectSchema): GenericObjec
     popularityRankProperty: popularityRankProperty
       ? normalizeSchemaPropertyIdentifier(popularityRankProperty, normalizedProperties)
       : undefined,
+    versionProperty: versionProperty
+      ? normalizeSchemaPropertyIdentifier(versionProperty, normalizedProperties)
+      : undefined,
     index: index ? normalizeIndexDefinition(index, normalizedProperties) : undefined,
     type: ValueType.Object,
   };

diff --git a/testing/upload_validation.ts b/testing/upload_validation.ts
@@ -1349,6 +1349,7 @@ ${endpointKey ? 'endpointKey is set' : `requiresEndpointUrl is ${requiresEndpoin
       memberGroupIdProperty: propertySchema.optional(),
       bodyTextProperty: propertySchema.optional(),
       popularityRankProperty: propertySchema.optional(),
+      versionProperty: propertySchema.optional(),
       options: zodOptionsFieldWithValues(z.object({}).passthrough(), false),
       requireForUpdates: z.boolean().optional(),
       index: indexSchema.optional(),
@@ -1611,6 +1612,14 @@ ${endpointKey ? 'endpointKey is set' : `requiresEndpointUrl is ${requiresEndpoin
           );
         };
 
+        const validateVersionProperty = () => {
+          return validateProperty(
+            'versionProperty',
+            versionPropertySchema => versionPropertySchema.type === ValueType.String,
+            `must refer to a "ValueType.String" property.`,
+          );
+        }
+
         validateTitleProperty();
         validateLinkProperty();
         validateImageProperty();
@@ -1626,6 +1635,7 @@ ${endpointKey ? 'endpointKey is set' : `requiresEndpointUrl is ${requiresEndpoin
         validateMemberGroupIdProperty();
         validatebodyTextProperty();
         validatePopularityRankProperty();
+        validateVersionProperty();
       })
       .superRefine((data, context) => {
         const schemaHelper = objectSchemaHelper(data as GenericObjectSchema);