@platecms/delta-plate-resource-notation 0.1.0

package/README.md

@@ -0,0 +1,43 @@
+# plate-resource-notation
+
+This package defines a PRN object, which allows for creation from strings conform PRN formatting or separate
+components.
+
+* [Definition](#definition)
+* [Requests and responses](#requests-and-responses)
+* [Features](#features)
+
+# Definition
+
+We define the Plate Resource Name (PRN, derived from URN) format as follows:
+`prn:<partition>:<organization-id>:<service>:<resource-type>:<resource-id>`
+
+- Partition: The instance of Plate Delta in which the resource resides. E.g. `plate`, `plate-dev`, `<client-name>`
+- Organization ID: The ID of the organization that owns the resource.
+- Service: The abbreviation of the name of the service that owns resource. E.g. `am` (Asset Manager), `cxc` (Content
+  Experience Center), etc.
+- Resource type: The type of the resource. E.g. asset, directory, content-type
+- Resource id: Id of the resource. E.g. 1234, abcd. This can be any string.
+
+Each name is formatted as slug: `asset-library`
+
+Some examples are:
+
+- `prn:plate:am:1234:asset:124124`
+- `prn:jumbo:cxc:abc:content-value:xyz`
+
+# Requests and responses
+
+A PRN should be formatted as a string in requests and responses. It will be parsed to a PRN object inside the
+microservice.  
+Inside of services we use PRN objects. In the database we use the id part of the PRN.
+
+# Features
+
+- `PRN` class to represent a PRN object. The constructor takes in the components of a PRN object.
+- Static method `fromString` to convert a string into a `PRN` instance.
+- `toString` on the PRN class to convert a PRN object into a string.
+- `InvalidPrnError` class to represent an error while parsing PRNs.
+- `TransformPrn` decorator to transform a PRN object into a string using `class-transformer`
+- `ServiceAbbreviation` enum to represent the service abbreviations.
+- `PRN_REGEX` constant to represent the regex used to validate PRN strings.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@platecms/delta-plate-resource-notation",
+  "version": "0.1.0",
+  "description": "PRNs are Plate's replacement for IDs. They contain context about the resource the PRN describes.",
+  "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/plate-resource-notation",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src/**/*"
+  ],
+  "dependencies": {
+    "class-transformer": "0.5.1",
+    "reflect-metadata": "0.2.2",
+    "tslib": "2.8.1"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./lib/invalid-prn.error";
+export * from "./lib/prn-regex.constant";
+export * from "./lib/transform-prn.decorator";
+export * from "./lib/services-abbreviation.enum";
+export * from "./lib/plate-resource-notation.model";

package/src/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/invalid-prn.error"), exports);
+tslib_1.__exportStar(require("./lib/prn-regex.constant"), exports);
+tslib_1.__exportStar(require("./lib/transform-prn.decorator"), exports);
+tslib_1.__exportStar(require("./lib/services-abbreviation.enum"), exports);
+tslib_1.__exportStar(require("./lib/plate-resource-notation.model"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/plate-resource-notation/src/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,mEAAyC;AACzC,wEAA8C;AAC9C,2EAAiD;AACjD,8EAAoD"}

package/src/lib/invalid-prn.error.d.ts

@@ -0,0 +1,3 @@
+export declare class InvalidPrnError extends Error {
+    constructor(message: string);
+}

package/src/lib/invalid-prn.error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidPrnError = void 0;
+class InvalidPrnError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = this.constructor.name;
+    }
+}
+exports.InvalidPrnError = InvalidPrnError;
+//# sourceMappingURL=invalid-prn.error.js.map

package/src/lib/invalid-prn.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalid-prn.error.js","sourceRoot":"","sources":["../../../../../../packages/plate-resource-notation/src/lib/invalid-prn.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAgB,SAAQ,KAAK;IACxC,YAAmB,OAAe;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AALD,0CAKC"}

package/src/lib/plate-resource-notation.model.d.ts

@@ -0,0 +1,13 @@
+import { ServiceAbbreviation } from "./services-abbreviation.enum";
+export type PrnString = `prn:${string}:${string}:${ServiceAbbreviation}:${string}:${string}`;
+export declare class PRN {
+    readonly partition: string;
+    readonly organizationId: string;
+    readonly service: ServiceAbbreviation;
+    readonly resourceType: string;
+    readonly resourceId: string;
+    constructor(partition: string, organizationId: string, service: ServiceAbbreviation, resourceType: string, resourceId: string);
+    static fromString(prnString: string): PRN;
+    toString(): string;
+    equals(other: unknown): boolean;
+}

package/src/lib/plate-resource-notation.model.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRN = void 0;
+const services_abbreviation_enum_1 = require("./services-abbreviation.enum");
+const invalid_prn_error_1 = require("./invalid-prn.error");
+const prn_regex_constant_1 = require("./prn-regex.constant");
+class PRN {
+    constructor(partition, organizationId, service, resourceType, resourceId) {
+        const componentArray = [partition, service, organizationId, resourceType, resourceId];
+        if (!componentArray.every((comp) => typeof comp === "string" && comp.length > 0)) {
+            throw new invalid_prn_error_1.InvalidPrnError("Invalid PRN component(s)! All components must be a non-empty string.");
+        }
+        if (componentArray.some((comp) => comp.includes(":"))) {
+            throw new invalid_prn_error_1.InvalidPrnError("Invalid PRN string specification! Components cannot contain ':'.");
+        }
+        this.partition = partition;
+        this.organizationId = organizationId;
+        this.service = service;
+        this.resourceType = resourceType;
+        this.resourceId = resourceId;
+    }
+    static fromString(prnString) {
+        if (!prn_regex_constant_1.PRN_REGEX.test(prnString)) {
+            throw new invalid_prn_error_1.InvalidPrnError(`Invalid PRN string '${prnString}'! Should match the pattern '${prn_regex_constant_1.PRN_REGEX.source}'`);
+        }
+        const [_, partition, organizationId, service, resourceType, resourceId] = prnString.split(":");
+        if (!Object.values(services_abbreviation_enum_1.ServiceAbbreviation).map(String).includes(service)) {
+            throw new invalid_prn_error_1.InvalidPrnError(`Invalid ServiceAbbreviation '${service}'! Use the ServiceAbbreviation enum.`);
+        }
+        return new PRN(partition, organizationId, service, resourceType, resourceId);
+    }
+    toString() {
+        return `prn:${this.partition}:${this.organizationId}:${this.service}:${this.resourceType}:${this.resourceId}`;
+    }
+    equals(other) {
+        if (!(other instanceof PRN)) {
+            return false;
+        }
+        for (const key of Object.keys(this)) {
+            if (this[key] !== other[key]) {
+                return false;
+            }
+        }
+        return true;
+    }
+}
+exports.PRN = PRN;
+//# sourceMappingURL=plate-resource-notation.model.js.map

package/src/lib/plate-resource-notation.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plate-resource-notation.model.js","sourceRoot":"","sources":["../../../../../../packages/plate-resource-notation/src/lib/plate-resource-notation.model.ts"],"names":[],"mappings":";;;AAAA,6EAAmE;AACnE,2DAAsD;AACtD,6DAAiD;AAIjD,MAAa,GAAG;IA8Bd,YACE,SAAiB,EACjB,cAAsB,EACtB,OAA4B,EAC5B,YAAoB,EACpB,UAAkB;QAElB,MAAM,cAAc,GAAa,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;QAEhG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YAC1F,MAAM,IAAI,mCAAe,CAAC,sEAAsE,CAAC,CAAC;QACpG,CAAC;QAED,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,mCAAe,CAAC,kEAAkE,CAAC,CAAC;QAChG,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAMM,MAAM,CAAC,UAAU,CAAC,SAAiB;QACxC,IAAI,CAAC,8BAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,mCAAe,CAAC,uBAAuB,SAAS,gCAAgC,8BAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACjH,CAAC;QAED,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAG/F,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gDAAmB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,mCAAe,CAAC,gCAAgC,OAAO,sCAAsC,CAAC,CAAC;QAC3G,CAAC;QAED,OAAO,IAAI,GAAG,CAAC,SAAS,EAAE,cAAc,EAAE,OAA8B,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;IACtG,CAAC;IAKM,QAAQ;QACb,OAAO,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;IAChH,CAAC;IAKM,MAAM,CAAC,KAAc;QAC1B,IAAI,CAAC,CAAC,KAAK,YAAY,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,GAAgB,CAAC,KAAK,KAAK,CAAC,GAAgB,CAAC,EAAE,CAAC;gBACvD,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhGD,kBAgGC"}

package/src/lib/prn-regex.constant.d.ts

@@ -0,0 +1 @@
+export declare const PRN_REGEX: RegExp;

package/src/lib/prn-regex.constant.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRN_REGEX = void 0;
+exports.PRN_REGEX = /^prn(:[A-Za-z0-9-_]+){5}$/u;
+//# sourceMappingURL=prn-regex.constant.js.map

package/src/lib/prn-regex.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prn-regex.constant.js","sourceRoot":"","sources":["../../../../../../packages/plate-resource-notation/src/lib/prn-regex.constant.ts"],"names":[],"mappings":";;;AAIa,QAAA,SAAS,GAAG,4BAA4B,CAAC"}

package/src/lib/services-abbreviation.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum ServiceAbbreviation {
+    ASSET_MANAGER = "am",
+    CONTENT_EXPERIENCE_CENTER = "cxc",
+    ACCESS_CONTROL = "ac",
+    EMAILS_SERVICE = "es",
+    ORGANIZATIONS_CENTER = "oc"
+}

package/src/lib/services-abbreviation.enum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceAbbreviation = void 0;
+var ServiceAbbreviation;
+(function (ServiceAbbreviation) {
+    ServiceAbbreviation["ASSET_MANAGER"] = "am";
+    ServiceAbbreviation["CONTENT_EXPERIENCE_CENTER"] = "cxc";
+    ServiceAbbreviation["ACCESS_CONTROL"] = "ac";
+    ServiceAbbreviation["EMAILS_SERVICE"] = "es";
+    ServiceAbbreviation["ORGANIZATIONS_CENTER"] = "oc";
+})(ServiceAbbreviation || (exports.ServiceAbbreviation = ServiceAbbreviation = {}));
+//# sourceMappingURL=services-abbreviation.enum.js.map

package/src/lib/services-abbreviation.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"services-abbreviation.enum.js","sourceRoot":"","sources":["../../../../../../packages/plate-resource-notation/src/lib/services-abbreviation.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,2CAAoB,CAAA;IACpB,wDAAiC,CAAA;IACjC,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;IACrB,kDAA2B,CAAA;AAC7B,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/src/lib/transform-prn.decorator.d.ts

@@ -0,0 +1,6 @@
+import "reflect-metadata";
+export interface TransformPrnOptions {
+    array?: boolean;
+    nullable?: boolean;
+}
+export declare function TransformPrn(transformPrnOptions?: TransformPrnOptions): PropertyDecorator;

package/src/lib/transform-prn.decorator.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformPrn = TransformPrn;
+const class_transformer_1 = require("class-transformer");
+const plate_resource_notation_model_1 = require("./plate-resource-notation.model");
+require("reflect-metadata");
+function TransformPrn(transformPrnOptions = { array: false, nullable: false }) {
+    return function (target, propertyKey) {
+        const reflectedType = Reflect.getMetadata("design:type", target, propertyKey);
+        if (reflectedType !== plate_resource_notation_model_1.PRN &&
+            !(reflectedType === Array && transformPrnOptions.array === true) &&
+            !(transformPrnOptions.nullable === true)) {
+            throw new TypeError("Only PRN types are valid for this decorator. If the field is nullable, you must specify it explicitly. " +
+                "If the field is an array of PRNs, you must specify the array option to be true (and be sure that the property is an array of PRNs).");
+        }
+        (0, class_transformer_1.Transform)(({ value }) => {
+            if (value === null || value === undefined) {
+                return value;
+            }
+            if (Array.isArray(value)) {
+                return value.map((prn) => plate_resource_notation_model_1.PRN.fromString(prn));
+            }
+            return plate_resource_notation_model_1.PRN.fromString(value);
+        }, {
+            toClassOnly: true,
+        })(target, propertyKey);
+        (0, class_transformer_1.Transform)(({ value }) => {
+            if (value === null || value === undefined) {
+                return value;
+            }
+            if (Array.isArray(value)) {
+                return value.map((prn) => prn.toString());
+            }
+            return value.toString();
+        }, {
+            toPlainOnly: true,
+        })(target, propertyKey);
+    };
+}
+//# sourceMappingURL=transform-prn.decorator.js.map

package/src/lib/transform-prn.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-prn.decorator.js","sourceRoot":"","sources":["../../../../../../packages/plate-resource-notation/src/lib/transform-prn.decorator.ts"],"names":[],"mappings":";;AAcA,oCAmDC;AAjED,yDAA8C;AAC9C,mFAAsD;AACtD,4BAA0B;AAY1B,SAAgB,YAAY,CAC1B,sBAA2C,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE;IAE5E,OAAO,UAAU,MAAc,EAAE,WAA4B;QAE3D,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC9E,IACE,aAAa,KAAK,mCAAG;YACrB,CAAC,CAAC,aAAa,KAAK,KAAK,IAAI,mBAAmB,CAAC,KAAK,KAAK,IAAI,CAAC;YAChE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,KAAK,IAAI,CAAC,EACxC,CAAC;YACD,MAAM,IAAI,SAAS,CACjB,yGAAyG;gBACvG,qIAAqI,CACxI,CAAC;QACJ,CAAC;QAED,IAAA,6BAAS,EACP,CAAC,EAAE,KAAK,EAAmD,EAAkC,EAAE;YAC7F,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC1C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YACjD,CAAC;YAED,OAAO,mCAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,EACD;YACE,WAAW,EAAE,IAAI;SAClB,CACF,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAEvB,IAAA,6BAAS,EACP,CAAC,EAAE,KAAK,EAA6C,EAAwC,EAAE;YAC7F,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC1C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC5C,CAAC;YAED,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC,EACD;YACE,WAAW,EAAE,IAAI;SAClB,CACF,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC"}