@stackbit/cms-sanity 0.2.44-staging.2 → 0.2.45-develop.2

package/dist/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveLabelFieldForModel = void 0;
+exports.typeIsPrimitive = exports.getItemTypeForListItem = exports.isLocalizedModelField = exports.resolvedFieldType = exports.getSanityAliasFieldType = exports.resolveLabelFieldForModel = void 0;
 const lodash_1 = __importDefault(require("lodash"));
 function resolveLabelFieldForModel(model, modelLabelFieldPath, fields) {
     let labelField = lodash_1.default.get(model, modelLabelFieldPath, null);
@@ -26,4 +26,96 @@ function resolveLabelFieldForModel(model, modelLabelFieldPath, fields) {
     return labelField || null;
 }
 exports.resolveLabelFieldForModel = resolveLabelFieldForModel;
+function getSanityAliasFieldType({ resolvedType, model, modelFieldPath }) {
+    const fieldAlias = model.context?.fieldAliasMap?.[modelFieldPath.join('.')] ?? [];
+    return fieldAlias?.find((alias) => alias.resolvedTypeName === resolvedType)?.origTypeName ?? resolvedType;
+}
+exports.getSanityAliasFieldType = getSanityAliasFieldType;
+function resolvedFieldType({ sanityFieldType, model, modelFieldPath }) {
+    const fieldAlias = model.context?.fieldAliasMap?.[modelFieldPath.join('.')] ?? [];
+    return fieldAlias?.find((alias) => alias.origTypeName === sanityFieldType)?.resolvedTypeName ?? sanityFieldType;
+}
+exports.resolvedFieldType = resolvedFieldType;
+function isLocalizedModelField(modelField) {
+    return 'localized' in modelField && modelField.localized;
+}
+exports.isLocalizedModelField = isLocalizedModelField;
+/**
+ * Sanity 'Array' field type can hold multiple field types.
+ *
+ * For example, Sanity Arrays can simultaneously include items of `model`
+ * and `reference` types. https://www.sanity.io/docs/array-type#wT47gyCx
+ *
+ * With that, Sanity Arrays cannot include both primitive and complex types:
+ * https://www.sanity.io/docs/array-type#fNBIr84P
+ *
+ * TODO:
+ * This is not yet supported by Stackbit's TypeScript types, so the `any`
+ * must be used. Additionally, if a Sanity array has multiple types of items one
+ * of which is the 'object' type, then it will also have the 'name' property to
+ * allow matching 'object' items to their types. The 'name' property is not
+ * supported in Stackbit list items, so '@ts-ignore' is used.
+ *
+ * However, Stackbit client app should be able to render this types of lists correctly.
+ *
+ * @example A list that can include items of type 'model', 'reference' and 'object'.
+ * {
+ *     type: 'list',
+ *     items: [{
+ *         type: 'model',
+ *         models: [...]
+ *     }, {
+ *         type: 'reference',
+ *         models: [...]
+ *     }, {
+ *         type: 'object',
+ *         name: 'nested_object_name',
+ *         fields: {...}
+ *     }]
+ * }
+ */
+function getItemTypeForListItem(listItem, fieldModel) {
+    const itemModels = fieldModel.items ?? { type: 'string' };
+    // in Sanity, list items may have multiple types, in this case, 'items' will be an array
+    if (!lodash_1.default.isArray(itemModels)) {
+        return itemModels;
+    }
+    // Handle primitive list item types
+    // For primitive list items, the list will hold the primitive values as is,
+    // therefore, use JavaScript's `typeof` to infer the type of the values
+    const type = lodash_1.default.get(listItem, '_type');
+    if (!type) {
+        const type = typeof listItem;
+        if (typeIsPrimitive(type)) {
+            return { type: type };
+        }
+        return null;
+    }
+    if (type === 'reference') {
+        return lodash_1.default.find(itemModels, { type: 'reference' }) ?? null;
+    }
+    else if (type === 'block') {
+        return lodash_1.default.find(itemModels, { type: 'richText' }) ?? null;
+    }
+    else {
+        return (lodash_1.default.find(itemModels, (itemModel) => {
+            if (itemModel.type === 'model') {
+                return lodash_1.default.includes(itemModel.models, type);
+            }
+            else {
+                // if field was one of base types (object, image, slug, etc.)
+                // and it had a "name" property, then the "_type" will be equal to that name,
+                // otherwise the "_type" will be equal to the base type
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                return itemModel.name === type || itemModel.type === type;
+            }
+        }) ?? null);
+    }
+}
+exports.getItemTypeForListItem = getItemTypeForListItem;
+function typeIsPrimitive(type) {
+    return ['string', 'number', 'boolean'].includes(type);
+}
+exports.typeIsPrimitive = typeIsPrimitive;
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAGvB,SAAgB,yBAAyB,CAAC,KAAU,EAAE,mBAA2B,EAAE,MAAe;IAC9F,IAAI,UAAU,GAAG,gBAAC,CAAC,GAAG,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACzD,IAAI,UAAU,EAAE;QACZ,OAAO,UAAU,CAAC;KACrB;IACD,wCAAwC;IACxC,IAAI,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9G,IAAI,CAAC,UAAU,EAAE;QACb,wCAAwC;QACxC,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;KAC7G;IACD,IAAI,CAAC,UAAU,EAAE;QACb,+BAA+B;QAC/B,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;KACnD;IACD,IAAI,UAAU,EAAE;QACZ,UAAU,GAAG,gBAAC,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;KAC1C;IACD,OAAO,UAAU,IAAI,IAAI,CAAC;AAC9B,CAAC;AAnBD,8DAmBC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAKvB,SAAgB,yBAAyB,CAAC,KAAU,EAAE,mBAA2B,EAAE,MAAe;IAC9F,IAAI,UAAU,GAAG,gBAAC,CAAC,GAAG,CAAC,KAAK,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACzD,IAAI,UAAU,EAAE;QACZ,OAAO,UAAU,CAAC;KACrB;IACD,wCAAwC;IACxC,IAAI,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9G,IAAI,CAAC,UAAU,EAAE;QACb,wCAAwC;QACxC,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;KAC7G;IACD,IAAI,CAAC,UAAU,EAAE;QACb,+BAA+B;QAC/B,UAAU,GAAG,gBAAC,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;KACnD;IACD,IAAI,UAAU,EAAE;QACZ,UAAU,GAAG,gBAAC,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;KAC1C;IACD,OAAO,UAAU,IAAI,IAAI,CAAC;AAC9B,CAAC;AAnBD,8DAmBC;AAED,SAAgB,uBAAuB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,cAAc,EAA+E;IACxJ,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,aAAa,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAClF,OAAO,UAAU,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,KAAK,YAAY,CAAC,EAAE,YAAY,IAAI,YAAY,CAAC;AAC9G,CAAC;AAHD,0DAGC;AAED,SAAgB,iBAAiB,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,cAAc,EAAkF;IACxJ,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,aAAa,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAClF,OAAO,UAAU,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,KAAK,eAAe,CAAC,EAAE,gBAAgB,IAAI,eAAe,CAAC;AACpH,CAAC;AAHD,8CAGC;AAED,SAAgB,qBAAqB,CAAC,UAA8D;IAChG,OAAO,WAAW,IAAI,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC;AAC7D,CAAC;AAFD,sDAEC;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,sBAAsB,CAAC,QAAa,EAAE,UAA8B;IAChF,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC1D,wFAAwF;IACxF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACxB,OAAO,UAAU,CAAC;KACrB;IACD,mCAAmC;IACnC,2EAA2E;IAC3E,uEAAuE;IACvE,MAAM,IAAI,GAAG,gBAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtC,IAAI,CAAC,IAAI,EAAE;QACP,MAAM,IAAI,GAAG,OAAO,QAAQ,CAAC;QAC7B,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE;YACvB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;SACzB;QACD,OAAO,IAAI,CAAC;KACf;IACD,IAAI,IAAI,KAAK,WAAW,EAAE;QACtB,OAAO,gBAAC,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;KAC5D;SAAM,IAAI,IAAI,KAAK,OAAO,EAAE;QACzB,OAAO,gBAAC,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,IAAI,IAAI,CAAC;KAC3D;SAAM;QACH,OAAO,CACH,gBAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;YAC7B,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC5B,OAAO,gBAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;aAC7C;iBAAM;gBACH,6DAA6D;gBAC7D,6EAA6E;gBAC7E,uDAAuD;gBACvD,6DAA6D;gBAC7D,aAAa;gBACb,OAAO,SAAS,CAAC,IAAI,KAAK,IAAI,IAAI,SAAS,CAAC,IAAI,KAAK,IAAI,CAAC;aAC7D;QACL,CAAC,CAAC,IAAI,IAAI,CACb,CAAC;KACL;AACL,CAAC;AArCD,wDAqCC;AAED,SAAgB,eAAe,CAAC,IAAY;IACxC,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC1D,CAAC;AAFD,0CAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stackbit/cms-sanity",
-  "version": "0.2.44-staging.2",
+  "version": "0.2.45-develop.2",
   "description": "Stackbit Sanity CMS Interface",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -32,9 +32,10 @@
     "@sanity/block-tools": "^2.29.3",
     "@sanity/client": "^3.3.0",
     "@sanity/schema": "^2.29.3",
-    "@stackbit/cms-core": "1.0.19-staging.2",
-    "@stackbit/types": "0.11.8-staging.1",
-    "@stackbit/utils": "0.4.8-staging.1",
+    "@sanity/types": "^3.31.0",
+    "@stackbit/cms-core": "1.0.20-develop.2",
+    "@stackbit/types": "0.11.9-develop.2",
+    "@stackbit/utils": "0.4.9-develop.2",
     "fs-extra": "^9.0.13",
     "glob": "10.2.6",
     "jsdom": "^20.0.0",
@@ -50,5 +51,5 @@
     "@types/tinycolor2": "^1.4.3",
     "@types/uuid": "^8.3.4"
   },
-  "gitHead": "c0d4161f28b2fd0acffb82fa86d84a610ecf6cdf"
+  "gitHead": "706448ac139536d5a06d36fd529b7544f3da77a4"
 }

package/src/index.ts

@@ -1,8 +1,8 @@
 import * as fetcher from './sanity-schema-fetcher';
 import * as converter from './sanity-schema-legacy-converter';
 import { UserCommandSpawner } from '@stackbit/types';
-
 export * from './sanity-content-source';
+export { SchemaContext, ModelContext, ModelWithContext } from './sanity-schema-converter';
 export { DocumentContext, AssetContext, ContextualDocument, ContextualAsset } from './sanity-document-converter';
 export { default as SanityEncoderDelegate } from './sanity-encoder-delegate';