@platecms/delta-client 0.1.0

package/README.md

@@ -0,0 +1,148 @@
+# delta-client-schema
+
+This library is part of the [Delta Client]() utility packages.
+It provides a utility to convert abstract building blocks and their values to usable data structures.
+
+## Usage
+
+Defining a schema looks as follows consists of a root object and nested fields.
+For example for a building block that has a welcome message, the schema would look like this:
+
+```ts
+import { s } from "@platecms/delta-client/schema";
+
+const heroBuildingBlock = s.object({
+    title: s.primitive(c('root', 'title')),
+    description: s.cast(c('root', 'description')),
+    images: s.array(s.asset())
+})
+
+```
+
+The schema can then be used to convert the abstract building block to a usable data structure:
+
+```ts
+import { p as parser } from "@platecms/delta-client/schema";
+
+const heroBuildingBlock = parser.parse(schema, buildingBlockFieldFulfillments);
+```
+
+Yields:
+
+```ts
+const heroBuildingBlock = {
+    title: "Hero Title",
+    description: {
+        type: 'root',
+        children: [
+            {
+                type: 'text',
+                value: 'Welcome to our website'
+            }
+        ]
+    },
+    images: [
+        {
+            fileName: "first image",
+            url: 'https://example.com/image.jpg',
+        }
+    ]
+}
+```
+
+## API
+
+### Object
+
+```ts
+s.object({
+    // shape of the object
+})
+```
+
+### Array
+
+Default array with one placeholder
+
+```ts
+s.array(
+    s.primitive('value')
+)
+```
+
+Array with a limit of the maximum number of items to display
+
+```ts
+s.array(
+    s.primitive('value'), 5 // limit to 5 items
+)
+```
+
+Array with an array of placeholders, also uses this a minimum number of items to display
+
+```ts
+s.array(
+    [
+        s.primitive('value'),
+        s.primitive('value'),
+        // other fields
+    ]
+)
+```
+
+### Primitive
+
+#### string
+
+```ts
+s.primitive('value')
+```
+
+#### number
+
+```ts
+s.primitive(23)
+```
+
+### Asset
+
+Accepts a partial Asset object as a placeholder
+
+```ts
+s.asset({
+    fileName: 'first',
+    url: 'https://example.com/image.jpg'
+})
+```
+
+### PathPart
+
+Accepts a partial PathPart object as a placeholder
+
+```ts
+s.pathPart({
+    path: '/blogs',
+})
+```
+
+### GridPlacement
+
+Accepts a partial GridPlacement object as a placeholder
+
+```ts
+s.gridPlacement({
+    prn: 'prn:grid:123',
+    row: 1
+})
+```
+
+### Cast
+
+Accepts a correct root object to cast the schema to a usable data structure
+
+```ts
+s.cast({
+    type: 'root',
+    children: []
+})
+```

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@platecms/delta-client",
+  "version": "0.1.0",
+  "description": "Utilities and functions to interact with the Delta CMS.",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://bitbucket.org/startmetplate/delta.git"
+  },
+  "homepage": "https://bitbucket.org/startmetplate/delta/src/dev/packages/delta-client",
+  "type": "commonjs",
+  "main": "./src/index.cjs.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "peerDependencies": {
+    "@platecms/delta-cast": "*",
+    "@graphql-typed-document-node/core": "3.2.0",
+    "graphql": "16.10.0",
+    "lodash": "4.17.21",
+    "slate": "0.112.0",
+    "slate-react": "0.112.1",
+    "tslib": "2.8.1",
+    "class-transformer": "0.5.1",
+    "reflect-metadata": "0.2.2",
+    "@apollo/client": "3.13.1",
+    "defu": "^6.1.4"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./index.esm.js",
+      "default": "./index.cjs.js",
+      "types": "./src/index.d.ts"
+    },
+    "./slate": {
+      "import": "./src/slate/index.esm.js",
+      "default": "./src/slate/index.cjs.js",
+      "types": "./src/slate/index.d.ts"
+    },
+    "./schema": {
+      "import": "./src/schema/index.esm.js",
+      "default": "./src/schema/index.cjs.js",
+      "types": "./src/schema/index.d.ts"
+    },
+    "./apollo": {
+      "import": "./src/apollo/index.esm.js",
+      "default": "./src/apollo/index.cjs.js",
+      "types": "./src/apollo/index.d.ts"
+    },
+    "./slate/index": "./src/slate/index.js"
+  },
+  "module": "./index.esm.js"
+}

package/src/__generated__/fragment-masking.d.ts

@@ -0,0 +1,19 @@
+import type { ResultOf, DocumentTypeDecoration, TypedDocumentNode } from '@graphql-typed-document-node/core';
+import type { Incremental } from './graphql';
+export type FragmentType<TDocumentType extends DocumentTypeDecoration<any, any>> = TDocumentType extends DocumentTypeDecoration<infer TType, any> ? [TType] extends [{
+    ' $fragmentName'?: infer TKey;
+}] ? TKey extends string ? {
+    ' $fragmentRefs'?: {
+        [key in TKey]: TType;
+    };
+} : never : never : never;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>): TType;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | undefined): TType | undefined;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null): TType | null;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null | undefined): TType | null | undefined;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>>): Array<TType>;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined): Array<TType> | null | undefined;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>): ReadonlyArray<TType>;
+export declare function useFragment<TType>(_documentNode: DocumentTypeDecoration<TType, any>, fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined): ReadonlyArray<TType> | null | undefined;
+export declare function makeFragmentData<F extends DocumentTypeDecoration<any, any>, FT extends ResultOf<F>>(data: FT, _fragment: F): FragmentType<F>;
+export declare function isFragmentReady<TQuery, TFrag>(queryNode: DocumentTypeDecoration<TQuery, any>, fragmentNode: TypedDocumentNode<TFrag>, data: FragmentType<TypedDocumentNode<Incremental<TFrag>, any>> | null | undefined): data is FragmentType<typeof fragmentNode>;

package/src/__generated__/fragment-masking.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFragment = useFragment;
+exports.makeFragmentData = makeFragmentData;
+exports.isFragmentReady = isFragmentReady;
+function useFragment(_documentNode, fragmentType) {
+    return fragmentType;
+}
+function makeFragmentData(data, _fragment) {
+    return data;
+}
+function isFragmentReady(queryNode, fragmentNode, data) {
+    const deferredFields = queryNode.__meta__
+        ?.deferredFields;
+    if (!deferredFields)
+        return true;
+    const fragDef = fragmentNode.definitions[0];
+    const fragName = fragDef?.name?.value;
+    const fields = (fragName && deferredFields[fragName]) || [];
+    return fields.length > 0 && fields.every(field => data && field in data);
+}
+//# sourceMappingURL=fragment-masking.js.map

package/src/__generated__/fragment-masking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fragment-masking.js","sourceRoot":"","sources":["../../../../../../packages/delta-client/src/__generated__/fragment-masking.ts"],"names":[],"mappings":";;AAyDA,kCAKC;AAGD,4CAKC;AACD,0CAeC;AA7BD,SAAgB,WAAW,CACzB,aAAiD,EACjD,YAA6M;IAE7M,OAAO,YAAmB,CAAC;AAC7B,CAAC;AAGD,SAAgB,gBAAgB,CAG9B,IAAQ,EAAE,SAAY;IACtB,OAAO,IAAuB,CAAC;AACjC,CAAC;AACD,SAAgB,eAAe,CAC7B,SAA8C,EAC9C,YAAsC,EACtC,IAAiF;IAEjF,MAAM,cAAc,GAAI,SAAgF,CAAC,QAAQ;QAC/G,EAAE,cAAc,CAAC;IAEnB,IAAI,CAAC,cAAc;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC,CAAuC,CAAC;IAClF,MAAM,QAAQ,GAAG,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC;IAEtC,MAAM,MAAM,GAAG,CAAC,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5D,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC;AAC3E,CAAC"}

package/src/__generated__/gql.d.ts

@@ -0,0 +1,3 @@
+import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
+export declare function graphql(source: string): unknown;
+export type DocumentType<TDocumentNode extends DocumentNode<any, any>> = TDocumentNode extends DocumentNode<infer TType, any> ? TType : never;

package/src/__generated__/gql.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.graphql = graphql;
+const documents = [];
+function graphql(source) {
+    return documents[source] ?? {};
+}
+//# sourceMappingURL=gql.js.map

package/src/__generated__/gql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gql.js","sourceRoot":"","sources":["../../../../../../packages/delta-client/src/__generated__/gql.ts"],"names":[],"mappings":";;AAmBA,0BAEC;AAjBD,MAAM,SAAS,GAAY,EAAE,CAAC;AAe9B,SAAgB,OAAO,CAAC,MAAc;IACpC,OAAQ,SAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;AAC1C,CAAC"}