@wix/patterns-cms 1.1.0

package/dist/types/adapter/createCmsFieldActions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createCmsFieldActions.d.ts","sourceRoot":"","sources":["../../../src/adapter/createCmsFieldActions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAS,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAS,YAAY,EAAE,MAAM,eAAe,CAAC;AAoCzD;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,WAAW,CAAC,cAAc,GAAG,IAAI,GACrD,YAAY,CAwJd"}

package/dist/types/adapter/fetchExternalDbConnections.d.ts

@@ -0,0 +1,11 @@
+import type { WixPatternsContainerParams } from '@wix/bex-core';
+import type { ExternalDbConnection } from './cmsPermissions';
+export type { ExternalDbConnection } from './cmsPermissions';
+type HttpClient = WixPatternsContainerParams['httpClient'];
+/**
+ * Lists the site's external-database connections in the source-neutral
+ * `ExternalDbConnection` shape. Ambassador client from the `@wix/bex-utils` bundle via
+ * `/http` (not `/builders` — `Error.captureStackTrace` crashes Firefox/Safari).
+ */
+export declare const fetchExternalDbConnections: (httpClient: HttpClient) => Promise<ExternalDbConnection[]>;
+//# sourceMappingURL=fetchExternalDbConnections.d.ts.map

package/dist/types/adapter/fetchExternalDbConnections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchExternalDbConnections.d.ts","sourceRoot":"","sources":["../../../src/adapter/fetchExternalDbConnections.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,YAAY,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,KAAK,UAAU,GAAG,0BAA0B,CAAC,YAAY,CAAC,CAAC;AAE3D;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,eACzB,UAAU,KACrB,QAAQ,oBAAoB,EAAE,CAahC,CAAC"}

package/dist/types/adapter/fetchUserPermissions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The current user's ABAC permission strings for a metasite. The ABAC client comes from
+ * the `@wix/bex-utils` bundle via `/http` (not `/builders` — `Error.captureStackTrace`
+ * crashes Firefox/Safari).
+ */
+export declare const fetchUserPermissions: (metasiteId: string) => Promise<string[]>;
+//# sourceMappingURL=fetchUserPermissions.d.ts.map

package/dist/types/adapter/fetchUserPermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchUserPermissions.d.ts","sourceRoot":"","sources":["../../../src/adapter/fetchUserPermissions.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,eACnB,MAAM,KACjB,QAAQ,MAAM,EAAE,CAUlB,CAAC"}

package/dist/types/adapter/filterUtils.d.ts

@@ -0,0 +1,14 @@
+import { items } from '@wix/data';
+import type { OffsetQuery, Schema } from '@wix/bex-core';
+type SchemaFields = Schema['fields'];
+export type CmsOperatorMethod = 'ge' | 'le' | 'contains' | 'isEmpty' | 'isNotEmpty';
+export declare function addFiltersToDataQuery({ dataQuery, query, fields, filterFieldMapping, }: {
+    dataQuery: items.WixDataQuery;
+    query: OffsetQuery;
+    fields: SchemaFields;
+    filterFieldMapping?: Record<string, {
+        fieldId: string;
+    }>;
+}): items.WixDataQuery;
+export {};
+//# sourceMappingURL=filterUtils.d.ts.map

package/dist/types/adapter/filterUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterUtils.d.ts","sourceRoot":"","sources":["../../../src/adapter/filterUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGlC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AASzD,KAAK,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAErC,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,UAAU,GACV,SAAS,GACT,YAAY,CAAC;AA4DjB,wBAAgB,qBAAqB,CAAC,EACpC,SAAS,EACT,KAAK,EACL,MAAM,EACN,kBAAkB,GACnB,EAAE;IACD,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;IAC9B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC1D,sBAyGA"}

package/dist/types/adapter/getFieldKey.d.ts

@@ -0,0 +1,3 @@
+/** Derives a unique CMS field key from a display name (dedupes against existing keys). */
+export declare const getFieldKey: (existingFieldKeys: string[], displayName: string) => string;
+//# sourceMappingURL=getFieldKey.d.ts.map

package/dist/types/adapter/getFieldKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFieldKey.d.ts","sourceRoot":"","sources":["../../../src/adapter/getFieldKey.ts"],"names":[],"mappings":"AAOA,0FAA0F;AAC1F,eAAO,MAAM,WAAW,sBACH,MAAM,EAAE,eACd,MAAM,KAClB,MAUF,CAAC"}

package/dist/types/adapter/index.d.ts

@@ -0,0 +1,15 @@
+export { createCmsSchemaLoader, fetchCmsCollection, type CreateCmsSchemaLoaderDeps, } from './loadCmsSchema';
+export { transformCmsSchema, type TransformCmsSchemaOptions, } from './transformCmsSchema';
+export { createCmsBackend } from './createCmsBackend';
+export { createCmsFieldActions } from './createCmsFieldActions';
+export { computeCmsPermissions, type CmsPermissions, type ExternalDbConnection, } from './cmsPermissions';
+export { CmsFieldTypeToPatternsFieldType, PatternsFieldTypeToCmsFieldType, CMS_EMAIL_TYPE, } from './cmsFieldTypeMap';
+export { addFiltersToDataQuery } from './filterUtils';
+export { addSearchToDataQuery } from './searchUtils';
+export { addSortToDataQuery } from './sortUtils';
+export { getFieldKey } from './getFieldKey';
+export { createCmsBackupConfig } from './cmsBackup';
+export { pollUntilReady, type PollOptions } from './pollUntilReady';
+export { fetchExternalDbConnections } from './fetchExternalDbConnections';
+export { fetchUserPermissions } from './fetchUserPermissions';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/adapter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EACL,qBAAqB,EACrB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,+BAA+B,EAC/B,+BAA+B,EAC/B,cAAc,GACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/types/adapter/loadCmsSchema.d.ts

@@ -0,0 +1,29 @@
+import { collections } from '@wix/data';
+import type { SchemaLoader, WixPatternsContainerParams } from '@wix/bex-core';
+import type { ExternalDbConnection } from './cmsPermissions';
+type HttpClient = WixPatternsContainerParams['httpClient'];
+export interface CreateCmsSchemaLoaderDeps {
+    httpClient: HttpClient;
+    /** Fetch the user's ABAC permissions for field-management gating. Default `false`. */
+    includeUserPermissions?: boolean;
+    /** Host-supplied metasite id; the ABAC permission fetch is skipped without it. */
+    metasiteId?: string;
+    /** Pre-resolved overrides (tests); skip the internal fetch when provided. */
+    userPermissions?: string[];
+    externalDbConnections?: ExternalDbConnection[];
+}
+/**
+ * Fetches the raw `@wix/data` collection. `includeAllowedDataPermissions` asks the
+ * server to evaluate the calling user against the collection's data-permission rules
+ * (`allowedDataPermissions` on the response — read by cmsPermissions.ts). The option
+ * is forwarded at runtime but stripped from the public typings, hence the cast.
+ */
+export declare function fetchCmsCollection(collectionId: string): Promise<collections.DataCollection>;
+/**
+ * Creates the CMS `SchemaLoader`: fetches the collection, ABAC permissions and
+ * external-DB connections in parallel and returns them as `LoadedSchema`.
+ * Failed permission/connection fetches degrade to `[]`.
+ */
+export declare function createCmsSchemaLoader<T extends Record<string, unknown> = Record<string, unknown>>(deps: CreateCmsSchemaLoaderDeps): SchemaLoader<T>;
+export {};
+//# sourceMappingURL=loadCmsSchema.d.ts.map

package/dist/types/adapter/loadCmsSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadCmsSchema.d.ts","sourceRoot":"","sources":["../../../src/adapter/loadCmsSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,OAAO,KAAK,EAEV,YAAY,EACZ,0BAA0B,EAC3B,MAAM,eAAe,CAAC;AAIvB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAI7D,KAAK,UAAU,GAAG,0BAA0B,CAAC,YAAY,CAAC,CAAC;AAE3D,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,UAAU,CAAC;IACvB,sFAAsF;IACtF,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,kFAAkF;IAClF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6EAA6E;IAC7E,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,qBAAqB,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAChD;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAQrC;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3D,IAAI,EAAE,yBAAyB,GAAG,YAAY,CAAC,CAAC,CAAC,CAiClD"}

package/dist/types/adapter/pollUntilReady.d.ts

@@ -0,0 +1,11 @@
+export interface PollOptions {
+    interval?: number;
+    maxAttempts?: number;
+    signal?: AbortSignal;
+}
+/**
+ * Polls `isDone` until it returns `true`, max attempts are exhausted, or the
+ * AbortSignal is aborted.
+ */
+export declare function pollUntilReady(isDone: () => Promise<boolean>, options?: PollOptions): Promise<void>;
+//# sourceMappingURL=pollUntilReady.d.ts.map

package/dist/types/adapter/pollUntilReady.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pollUntilReady.d.ts","sourceRoot":"","sources":["../../../src/adapter/pollUntilReady.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,IAAI,CAAC,CA2Bf"}

package/dist/types/adapter/searchUtils.d.ts

@@ -0,0 +1,12 @@
+import { items } from '@wix/data';
+import type { OffsetQuery, Schema } from '@wix/bex-core';
+type SchemaFields = Schema['fields'];
+/** Free-text search: OR of `contains` over `SHORT_TEXT`/`LONG_TEXT` fields in `searchableFieldIds`. */
+export declare function addSearchToDataQuery({ dataQuery, query, fields, searchableFieldIds, }: {
+    dataQuery: items.WixDataQuery;
+    query: OffsetQuery;
+    fields: SchemaFields;
+    searchableFieldIds: string[];
+}): items.WixDataQuery;
+export {};
+//# sourceMappingURL=searchUtils.d.ts.map

package/dist/types/adapter/searchUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchUtils.d.ts","sourceRoot":"","sources":["../../../src/adapter/searchUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEzD,KAAK,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAIrC,uGAAuG;AACvG,wBAAgB,oBAAoB,CAAC,EACnC,SAAS,EACT,KAAK,EACL,MAAM,EACN,kBAAkB,GACnB,EAAE;IACD,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;IAC9B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,sBAwBA"}

package/dist/types/adapter/sortUtils.d.ts

@@ -0,0 +1,11 @@
+import { items } from '@wix/data';
+import type { OffsetQuery, Schema } from '@wix/bex-core';
+type SchemaFields = Schema['fields'];
+/** Applies the query's sort to the WQL query — only `sortable` fields. */
+export declare function addSortToDataQuery({ dataQuery, query, fields, }: {
+    dataQuery: items.WixDataQuery;
+    query: OffsetQuery;
+    fields: SchemaFields;
+}): items.WixDataQuery;
+export {};
+//# sourceMappingURL=sortUtils.d.ts.map

package/dist/types/adapter/sortUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortUtils.d.ts","sourceRoot":"","sources":["../../../src/adapter/sortUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEzD,KAAK,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;AAErC,0EAA0E;AAC1E,wBAAgB,kBAAkB,CAAC,EACjC,SAAS,EACT,KAAK,EACL,MAAM,GACP,EAAE;IACD,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;IAC9B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;CACtB,sBAkBA"}

package/dist/types/adapter/transformCmsSchema.d.ts

@@ -0,0 +1,12 @@
+import { collections } from '@wix/data';
+import type { Schema } from '@wix/bex-core';
+import { type ExternalDbConnection } from './cmsPermissions';
+export interface TransformCmsSchemaOptions {
+    /** Current user's ABAC permission strings. */
+    userPermissions?: string[];
+    /** External-DB connections (drive EXTERNAL-collection editability). */
+    externalDbConnections?: ExternalDbConnection[];
+}
+/** Transforms a raw `@wix/data` `DataCollection` into the source-neutral `Schema`. */
+export declare function transformCmsSchema(schema: collections.DataCollection, options?: TransformCmsSchemaOptions): Schema;
+//# sourceMappingURL=transformCmsSchema.d.ts.map

package/dist/types/adapter/transformCmsSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformCmsSchema.d.ts","sourceRoot":"","sources":["../../../src/adapter/transformCmsSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAS,MAAM,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,kBAAkB,CAAC;AAE1B,MAAM,WAAW,yBAAyB;IACxC,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,uEAAuE;IACvE,qBAAqB,CAAC,EAAE,oBAAoB,EAAE,CAAC;CAChD;AAED,sFAAsF;AACtF,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,WAAW,CAAC,cAAc,EAClC,OAAO,GAAE,yBAA8B,GACtC,MAAM,CAkFR"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './adapter';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

package/package.json

@@ -0,0 +1,123 @@
+{
+  "name": "@wix/patterns-cms",
+  "version": "1.1.0",
+  "license": "UNLICENSED",
+  "author": {
+    "name": "Cairo",
+    "email": "cairo@wix.com"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "sideEffects": false,
+  "scripts": {
+    "build": "yoshi-library build",
+    "start": "yoshi-library start",
+    "test": "yarn test:unit",
+    "test:unit": "yoshi-library test",
+    "coverage": "yarn test:unit --collectCoverage",
+    "jest:clear": "jest --clearCache",
+    "lint": "yoshi-library lint",
+    "type-check": "tsc"
+  },
+  "files": [
+    "dist/cjs",
+    "dist/esm",
+    "dist/types"
+  ],
+  "dependencies": {
+    "@babel/runtime": "^7.0.0",
+    "@wix/bex-core": "2.323.0",
+    "@wix/bex-utils": "2.110.0",
+    "@wix/data": "^1.0.323",
+    "lodash": "^4.17.20",
+    "tslib": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@wix/essentials": ">=0.1.26"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.168",
+    "@wix/eslint-config-yoshi": "^6.74.0",
+    "@wix/essentials": "^0.1.26",
+    "@wix/jest-yoshi-preset-base": "^6.74.0",
+    "@wix/yoshi-flow-library": "^6.74.0",
+    "ts-node": "^10.9.1",
+    "typescript": "~4.9.5"
+  },
+  "jest": {
+    "preset": "@wix/jest-yoshi-preset-base"
+  },
+  "eslintConfig": {
+    "extends": "@wix/eslint-config-yoshi",
+    "rules": {
+      "react-hooks/exhaustive-deps": "off",
+      "prettier/prettier": [
+        "warn",
+        {
+          "singleQuote": true,
+          "trailingComma": "all"
+        },
+        {
+          "usePrettierrc": false
+        }
+      ]
+    },
+    "overrides": [
+      {
+        "files": [
+          "src/**/*.ts*"
+        ],
+        "rules": {
+          "no-restricted-imports": [
+            "error",
+            {
+              "patterns": [
+                {
+                  "group": [
+                    "src"
+                  ]
+                },
+                {
+                  "group": [
+                    "@wix/patterns",
+                    "@wix/patterns/*"
+                  ],
+                  "message": "@wix/patterns-cms must never depend on cairo (@wix/patterns)."
+                }
+              ]
+            }
+          ],
+          "no-console": [
+            "error",
+            {
+              "allow": [
+                "warn",
+                "error"
+              ]
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "wix": {
+    "artifact": {
+      "groupId": "com.wixpress",
+      "artifactId": "patterns-cms"
+    },
+    "validations": {
+      "source": [
+        "lint"
+      ]
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "wallaby": {
+    "autoDetect": true
+  },
+  "falconPackageHash": "d91175a2753488a0d751505f38578446ede238a1210d6431d0bac8ea"
+}