@platecms/delta-types 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# types
+
+This package contains a number of general utility types that are used throughout many projects.
+
+- [Features](#features)
+
+# Features
+
+- `Constructor<T>` which is a type that represents the constructor of a class.
+- `ContentValueTypeName<T>` type which maps the type `T` to the corresponding `ContentValueTypeName`.
+- `ContentValueTypeNames` which represents the names of the different types which a Content Value can be.
+- `ContentValueType` which represents the different types which a Content Value can be.
+- `HeaderKeys` enum which represents the keys of custom request headers.
+- `PrimitiveConstructor` union which represents the constructors of the primitive types.
+- `Primitive` union which represents the primitive types.
+- `ReturnConstructorFunction` function which returns the constructor of a function. This is useful for certain metadata
+  applications.
+- `Stage` enum which represents the different stages in which Content can be.
+- `isPrimitiveType` function which checks if a given constructor is a primitive constructor.

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@platecms/delta-types",
+  "version": "0.1.0",
+  "description": "This package contains various utility types.",
+  "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/types",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "peerDependencies": {
+    "@platecms/delta-cast": "*",
+    "@platecms/delta-plate-resource-notation": "*",
+    "class-transformer": "0.5.1",
+    "reflect-metadata": "0.2.2",
+    "tslib": "2.8.1"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./lib/return-constructor-function.type";
+export * from "./lib/constructor.type";
+export * from "./lib/content-value-type.type";
+export * from "./lib/primitive.type";
+export * from "./lib/stage.enum";
+export * from "./lib/header-keys.enum";

package/src/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/return-constructor-function.type"), exports);
+tslib_1.__exportStar(require("./lib/constructor.type"), exports);
+tslib_1.__exportStar(require("./lib/content-value-type.type"), exports);
+tslib_1.__exportStar(require("./lib/primitive.type"), exports);
+tslib_1.__exportStar(require("./lib/stage.enum"), exports);
+tslib_1.__exportStar(require("./lib/header-keys.enum"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/types/src/index.ts"],"names":[],"mappings":";;;AAAA,iFAAuD;AACvD,iEAAuC;AACvC,wEAA8C;AAC9C,+DAAqC;AACrC,2DAAiC;AACjC,iEAAuC"}

package/src/lib/constructor.type.d.ts

@@ -0,0 +1 @@
+export type Constructor<T = unknown> = new (...args: any[]) => T;

package/src/lib/constructor.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=constructor.type.js.map

package/src/lib/constructor.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constructor.type.js","sourceRoot":"","sources":["../../../../../../packages/types/src/lib/constructor.type.ts"],"names":[],"mappings":""}

package/src/lib/content-value-type.type.d.ts

@@ -0,0 +1,16 @@
+import { PRN } from "@platecms/delta-plate-resource-notation";
+import { Primitive } from "./primitive.type";
+import { Root } from "@platecms/delta-cast";
+export declare enum ContentValueTypeNames {
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    BOOLEAN = "BOOLEAN",
+    DATE = "DATE",
+    CONTENT_ITEM = "CONTENT_ITEM",
+    ASSET = "ASSET",
+    PATH_PART = "PATH_PART",
+    GRID_PLACEMENT = "GRID_PLACEMENT",
+    SMART_TEXT = "SMART_TEXT"
+}
+export type ContentValueType = Primitive | PRN | Root;
+export type ContentValueTypeName<T> = T extends string ? ContentValueTypeNames.STRING : T extends number ? ContentValueTypeNames.NUMBER : T extends boolean ? ContentValueTypeNames.BOOLEAN : T extends Date ? ContentValueTypeNames.DATE : T extends Root ? ContentValueTypeNames.SMART_TEXT : T extends PRN ? ContentValueTypeNames.ASSET | ContentValueTypeNames.CONTENT_ITEM | ContentValueTypeNames.GRID_PLACEMENT | ContentValueTypeNames.PATH_PART : never;

package/src/lib/content-value-type.type.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentValueTypeNames = void 0;
+var ContentValueTypeNames;
+(function (ContentValueTypeNames) {
+    ContentValueTypeNames["STRING"] = "STRING";
+    ContentValueTypeNames["NUMBER"] = "NUMBER";
+    ContentValueTypeNames["BOOLEAN"] = "BOOLEAN";
+    ContentValueTypeNames["DATE"] = "DATE";
+    ContentValueTypeNames["CONTENT_ITEM"] = "CONTENT_ITEM";
+    ContentValueTypeNames["ASSET"] = "ASSET";
+    ContentValueTypeNames["PATH_PART"] = "PATH_PART";
+    ContentValueTypeNames["GRID_PLACEMENT"] = "GRID_PLACEMENT";
+    ContentValueTypeNames["SMART_TEXT"] = "SMART_TEXT";
+})(ContentValueTypeNames || (exports.ContentValueTypeNames = ContentValueTypeNames = {}));
+//# sourceMappingURL=content-value-type.type.js.map

package/src/lib/content-value-type.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-value-type.type.js","sourceRoot":"","sources":["../../../../../../packages/types/src/lib/content-value-type.type.ts"],"names":[],"mappings":";;;AAIA,IAAY,qBAUX;AAVD,WAAY,qBAAqB;IAC/B,0CAAiB,CAAA;IACjB,0CAAiB,CAAA;IACjB,4CAAmB,CAAA;IACnB,sCAAa,CAAA;IACb,sDAA6B,CAAA;IAC7B,wCAAe,CAAA;IACf,gDAAuB,CAAA;IACvB,0DAAiC,CAAA;IACjC,kDAAyB,CAAA;AAC3B,CAAC,EAVW,qBAAqB,qCAArB,qBAAqB,QAUhC"}

package/src/lib/header-keys.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum HeaderKeys {
+    X_DELTA_ORGANIZATION = "x-delta-organization",
+    X_DELTA_TRACE_ID = "x-delta-trace-id",
+    X_DELTA_STAGE = "x-delta-stage"
+}

package/src/lib/header-keys.enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeaderKeys = void 0;
+var HeaderKeys;
+(function (HeaderKeys) {
+    HeaderKeys["X_DELTA_ORGANIZATION"] = "x-delta-organization";
+    HeaderKeys["X_DELTA_TRACE_ID"] = "x-delta-trace-id";
+    HeaderKeys["X_DELTA_STAGE"] = "x-delta-stage";
+})(HeaderKeys || (exports.HeaderKeys = HeaderKeys = {}));
+//# sourceMappingURL=header-keys.enum.js.map

package/src/lib/header-keys.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"header-keys.enum.js","sourceRoot":"","sources":["../../../../../../packages/types/src/lib/header-keys.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,2DAA6C,CAAA;IAC7C,mDAAqC,CAAA;IACrC,6CAA+B,CAAA;AACjC,CAAC,EAJW,UAAU,0BAAV,UAAU,QAIrB"}

package/src/lib/primitive.type.d.ts

@@ -0,0 +1,4 @@
+import { Constructor } from "./constructor.type";
+export type Primitive = Date | boolean | number | string;
+export type PrimitiveConstructor = Boolean | BooleanConstructor | Date | DateConstructor | Number | NumberConstructor | String | StringConstructor;
+export declare function isPrimitiveType(type: Constructor): boolean;

package/src/lib/primitive.type.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPrimitiveType = isPrimitiveType;
+function isPrimitiveType(type) {
+    return type === String || type === Number || type === Boolean || type === Date;
+}
+//# sourceMappingURL=primitive.type.js.map

package/src/lib/primitive.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"primitive.type.js","sourceRoot":"","sources":["../../../../../../packages/types/src/lib/primitive.type.ts"],"names":[],"mappings":";;AAgBA,0CAEC;AAFD,SAAgB,eAAe,CAAC,IAAiB;IAC/C,OAAO,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,IAAI,CAAC;AACjF,CAAC"}

package/src/lib/return-constructor-function.type.d.ts

@@ -0,0 +1,2 @@
+import { Constructor } from "./constructor.type";
+export type ReturnConstructorFunction<TType = unknown> = () => Constructor<TType>;

package/src/lib/return-constructor-function.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=return-constructor-function.type.js.map

package/src/lib/return-constructor-function.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"return-constructor-function.type.js","sourceRoot":"","sources":["../../../../../../packages/types/src/lib/return-constructor-function.type.ts"],"names":[],"mappings":""}

package/src/lib/stage.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum Stage {
+    DEVELOPMENT = "DEVELOPMENT",
+    PRODUCTION = "PRODUCTION"
+}

package/src/lib/stage.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stage = void 0;
+var Stage;
+(function (Stage) {
+    Stage["DEVELOPMENT"] = "DEVELOPMENT";
+    Stage["PRODUCTION"] = "PRODUCTION";
+})(Stage || (exports.Stage = Stage = {}));
+//# sourceMappingURL=stage.enum.js.map

package/src/lib/stage.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage.enum.js","sourceRoot":"","sources":["../../../../../../packages/types/src/lib/stage.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oCAA2B,CAAA;IAC3B,kCAAyB,CAAA;AAC3B,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB"}