@postxl/schema 0.0.2

package/dist/samples/sample-schemas.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sampleSchemas = void 0;
+const la_schema_json_1 = __importDefault(require("./la.schema.json"));
+const mca_schema_json_1 = __importDefault(require("./mca.schema.json"));
+const ring_schema_json_1 = __importDefault(require("./ring.schema.json"));
+const simple_schema_json_1 = __importDefault(require("./simple.schema.json"));
+const subex_schema_json_1 = __importDefault(require("./subex.schema.json"));
+const usp_msm_schema_json_1 = __importDefault(require("./usp-msm.schema.json"));
+exports.sampleSchemas = {
+    la: la_schema_json_1.default,
+    mca: mca_schema_json_1.default,
+    ring: ring_schema_json_1.default,
+    simple: simple_schema_json_1.default,
+    subex: subex_schema_json_1.default,
+    uspmsm: usp_msm_schema_json_1.default,
+};

package/dist/samples/simple.schema.json

@@ -0,0 +1,250 @@
+{
+    "name": "PXL Template Project",
+    "slug": "pxl-template",
+    "description": "A template for PostXL projects.",
+    "projectType": {
+        "kind": "workspace",
+        "projectDirectory": "template"
+    },
+    "version": "0.0.1",
+    "schemas": ["PXL", "Data"],
+    "defaultSchema": "Data",
+    "systemUser": {
+        "name": "System",
+        "email": "system@postxl.com",
+        "sub": null
+    },
+    "standardModels": ["Action", "ActionOperation", "File", "User"],
+    "models": [
+        {
+            "name": "Country",
+            "description": "A lookup table, demonstrating the use of a @@IsDefault. See description of `isDefault` field for details.",
+            "schema": "Data",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the country.",
+                    "faker": "location.country"
+                },
+                {
+                    "name": "countryCode",
+                    "type": "String",
+                    "label": "CountryCode",
+                    "description": "The country's ISO 3166-1 alpha-2 code.",
+                    "faker": "location.countryCode"
+                },
+                {
+                    "name": "isDefault",
+                    "type": "Boolean",
+                    "label": "IsDefault",
+                    "description": "The IsDefault identifies which boolean field to be used to identify the default value.",
+                    "seed": false
+                }
+            ],
+            "defaultField": "isDefault",
+            "seed": [
+                {
+                    "id": "US",
+                    "name": "US",
+                    "countryCode": "US",
+                    "isDefault": true
+                },
+                {
+                    "id": "DE",
+                    "name": "Germany",
+                    "countryCode": "DE",
+                    "isDefault": false
+                },
+                {
+                    "id": "DK",
+                    "name": "Denmark",
+                    "countryCode": "DK",
+                    "isDefault": false
+                }
+            ],
+            "faker": {
+                "items": 10
+            }
+        },
+        {
+            "name": "Post",
+            "description": "A blog post entry.",
+            "schema": "Data",
+            "fields": [
+                {
+                    "name": "title",
+                    "type": "String",
+                    "label": "Blog Title",
+                    "faker": "lorem.sentence"
+                },
+                {
+                    "name": "body",
+                    "type": "String",
+                    "label": "Body",
+                    "faker": "lorem.paragraph"
+                },
+                {
+                    "name": "author",
+                    "type": "DiscriminatedUnion",
+                    "label": "Blog Author",
+                    "commonFields": [
+                        {
+                            "name": "email",
+                            "type": "String",
+                            "faker": "internet.email"
+                        }
+                    ],
+                    "members": [
+                        {
+                            "type": "user",
+                            "label": "existing user",
+                            "fields": [
+                                {
+                                    "name": "userId",
+                                    "type": "User"
+                                }
+                            ]
+                        },
+                        {
+                            "type": "anonymous",
+                            "label": "Anonymous user",
+                            "fields": [
+                                {
+                                    "name": "name",
+                                    "type": "String?",
+                                    "faker": "person.fullName"
+                                }
+                            ]
+                        },
+                        {
+                            "type": "guest",
+                            "label": "Guest user"
+                        }
+                    ]
+                },
+                {
+                    "name": "nextPostId",
+                    "type": "Post?",
+                    "label": "Next post",
+                    "description": "The post that you should see after reading this one."
+                },
+                {
+                    "name": "publicationId",
+                    "type": "Publication?",
+                    "label": "Publication",
+                    "description": "Posts are bundled in publications."
+                }
+            ],
+            "standardFields": ["id", "createdAt", "updatedAt"],
+            "labelField": "title",
+            "standardActions": ["create", "update", "upsert", "delete", "clone", "cloneMany"],
+            "actions": {
+                "publish": "Publish a post",
+                "unpublish": "Unpublish a post"
+            },
+            "faker": {
+                "items": 10
+            }
+        },
+        {
+            "name": "Publication",
+            "description": "",
+            "schema": "Data",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "faker": "lorem.sentence"
+                },
+                {
+                    "name": "featuredPostId",
+                    "type": "Post?",
+                    "label": "FeaturedPostId",
+                    "prismaRelationFieldName": "featuredPost",
+                    "deepClone": true
+                },
+                {
+                    "name": "mostLikedPostId",
+                    "type": "Post?",
+                    "label": "MostLikedPostId",
+                    "prismaRelationFieldName": "mostLikedPost"
+                },
+                {
+                    "name": "status",
+                    "type": "PublicationStatus",
+                    "label": "Status"
+                }
+            ],
+            "standardActions": [
+                "create",
+                "createMany",
+                "update",
+                "updateMany",
+                "upsert",
+                "upsertMany",
+                "delete",
+                "deleteMany",
+                "clone",
+                "cloneMany"
+            ],
+            "actions": {
+                "addPost": "Add a post to a publication",
+                "removePost": "Remove a post from a publication",
+                "reorderPosts": "Reorder posts in a publication"
+            },
+            "faker": {
+                "items": 3
+            }
+        },
+        {
+            "name": "ViewStatistic",
+            "description": "An example of an in memory model which is transient. It will store the view stats for a given post.",
+            "schema": "Data",
+            "isReadonly": true,
+            "repository": {
+                "type": "InMemory"
+            },
+            "standardFields": ["id"],
+            "fields": [
+                {
+                    "name": "postId",
+                    "type": "Post",
+                    "label": "PostId",
+                    "description": "The post that the view stats belong to."
+                },
+                {
+                    "name": "views",
+                    "type": "Int",
+                    "label": "Views",
+                    "description": "The number of views for the post."
+                },
+                {
+                    "name": "entryName",
+                    "type": "String",
+                    "description": "A field that tests the isUnique constraint.",
+                    "isUnique": true
+                }
+            ]
+        }
+    ],
+    "enums": [
+        {
+            "name": "PublicationStatus",
+            "description": "Status a publication can have.",
+            "schema": "Data",
+            "members": [
+                {
+                    "value": "Draft",
+                    "description": "The publication is in draft mode."
+                },
+                {
+                    "value": "Published",
+                    "description": "The publication is published."
+                }
+            ]
+        }
+    ]
+}