@platecms/delta-plate-resource-notation 0.13.0 → 1.2.0

package/README.md

@@ -14,8 +14,7 @@ We define the Plate Resource Name (PRN, derived from URN) format as follows:
 
 - 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.
+- Service: The abbreviation of the name of the service that owns resource. E.g. `ps` (Platform Service), `cms` (Content Management 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.
 
@@ -23,8 +22,8 @@ Each name is formatted as slug: `asset-library`
 
 Some examples are:
 
-- `prn:plate:am:1234:asset:124124`
-- `prn:jumbo:cxc:abc:content-value:xyz`
+- `prn:plate:ps:1234:asset:124124`
+- `prn:jumbo:cms:abc:content-value:xyz`
 
 # Requests and responses
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-plate-resource-notation",
-  "version": "0.13.0",
+  "version": "1.2.0",
   "description": "PRNs are Plate's replacement for IDs. They contain context about the resource the PRN describes.",
   "license": "UNLICENSED",
   "publishConfig": {

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

@@ -8,7 +8,7 @@ describe("PRN", () => {
       // Arrange
       const partition = "aa";
       const organizationId = "bb";
-      const service = ServiceAbbreviation.ASSET_MANAGER;
+      const service = ServiceAbbreviation.PLATFORM_SERVICE;
       const resourceType = "dd";
       const resourceId = "ee";
 
@@ -28,14 +28,14 @@ describe("PRN", () => {
       {
         partition: "aa",
         organizationId: "bb",
-        service: ServiceAbbreviation.ASSET_MANAGER,
+        service: ServiceAbbreviation.PLATFORM_SERVICE,
         resourceName: "cc",
         resourceId: "", // Empty part
       },
       {
         partition: "aa",
         organizationId: "b:b", // Part has a colon in it
-        service: ServiceAbbreviation.ASSET_MANAGER,
+        service: ServiceAbbreviation.PLATFORM_SERVICE,
         resourceName: "cc",
         resourceId: "dd",
       },
@@ -51,7 +51,7 @@ describe("PRN", () => {
       {
         partition: "ab",
         organizationId: "cd",
-        service: ServiceAbbreviation.CONTENT_EXPERIENCE_CENTER,
+        service: ServiceAbbreviation.CONTENT_MANAGEMENT_SERVICE,
         resourceType: "ef",
         resourceId: "gh",
       },
@@ -66,8 +66,8 @@ describe("PRN", () => {
 
   describe("fromString", () => {
     it("creates a PRN for a given PRN string successfully", async () => {
-      const result: PRN = PRN.fromString(`prn:aa:bb:${ServiceAbbreviation.ACCESS_CONTROL}:cc:dd`);
-      expect(result).toStrictEqual(new PRN("aa", "bb", ServiceAbbreviation.ACCESS_CONTROL, "cc", "dd"));
+      const result: PRN = PRN.fromString(`prn:aa:bb:${ServiceAbbreviation.PLATFORM_SERVICE}:cc:dd`);
+      expect(result).toStrictEqual(new PRN("aa", "bb", ServiceAbbreviation.PLATFORM_SERVICE, "cc", "dd"));
     });
 
     it.each([
@@ -81,22 +81,22 @@ describe("PRN", () => {
   describe("equals", () => {
     it("Successfully checks equivalence of two equivalent PRN objects", async () => {
       expect(
-        new PRN("ab", "cd", ServiceAbbreviation.ORGANIZATIONS_CENTER, "ef", "gh").equals(
-          new PRN("ab", "cd", ServiceAbbreviation.ORGANIZATIONS_CENTER, "ef", "gh"),
+        new PRN("ab", "cd", ServiceAbbreviation.PLATFORM_SERVICE, "ef", "gh").equals(
+          new PRN("ab", "cd", ServiceAbbreviation.PLATFORM_SERVICE, "ef", "gh"),
         ),
       ).toStrictEqual(true);
     });
 
     it("Successfully checks equivalence of two distinct PRN objects", async () => {
       expect(
-        new PRN("aa", "bb", ServiceAbbreviation.EMAILS_SERVICE, "cc", "dd").equals(
-          new PRN("zz", "cd", ServiceAbbreviation.EMAILS_SERVICE, "ef", "gh"),
+        new PRN("aa", "bb", ServiceAbbreviation.PLATFORM_SERVICE, "cc", "dd").equals(
+          new PRN("zz", "cd", ServiceAbbreviation.PLATFORM_SERVICE, "ef", "gh"),
         ),
       ).toStrictEqual(false);
     });
 
     it("Successfully checks equivalence of one PRN object and a different object", async () => {
-      expect(new PRN("aa", "bb", ServiceAbbreviation.EMAILS_SERVICE, "cc", "dd").equals(1234)).toStrictEqual(false);
+      expect(new PRN("aa", "bb", ServiceAbbreviation.PLATFORM_SERVICE, "cc", "dd").equals(1234)).toStrictEqual(false);
     });
   });
 });

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

@@ -16,7 +16,7 @@ export class PRN {
   public readonly organizationId: string;
 
   /**
-   * Name of service that owns resource. E.g. 'cxc', 'oc'.
+   * Name of service that owns resource. E.g. 'cms', 'ps'.
    */
   public readonly service: ServiceAbbreviation;
 

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

@@ -9,12 +9,12 @@ describe("PRN_REGEX", () => {
   });
 
   it.each([
-    `prn:plate:1:${ServiceAbbreviation.EMAILS_SERVICE}:-any:1234`,
-    `prn:plate:12:${ServiceAbbreviation.ACCESS_CONTROL}:anything:a9ff417a-d8f7-1125-9ad7-7941d6222227`,
-    `prn:plate:1:${ServiceAbbreviation.ORGANIZATIONS_CENTER}:-something_else:1234`,
-    `prn:plate:1:${ServiceAbbreviation.CONTENT_EXPERIENCE_CENTER}:-any:8aaf417a-d8f7-4a6a-9ad7-7941d6222227`,
-    `prn:plate:1:${ServiceAbbreviation.ASSET_MANAGER}:-any:some_id`,
-    `prn:plate:1:${ServiceAbbreviation.CONTENT_EXPERIENCE_CENTER}:-any:someId`,
+    `prn:plate:1:${ServiceAbbreviation.PLATFORM_SERVICE}:-any:1234`,
+    `prn:plate:12:${ServiceAbbreviation.PLATFORM_SERVICE}:anything:a9ff417a-d8f7-1125-9ad7-7941d6222227`,
+    `prn:plate:1:${ServiceAbbreviation.PLATFORM_SERVICE}:-something_else:1234`,
+    `prn:plate:1:${ServiceAbbreviation.CONTENT_MANAGEMENT_SERVICE}:-any:8aaf417a-d8f7-4a6a-9ad7-7941d6222227`,
+    `prn:plate:1:${ServiceAbbreviation.PLATFORM_SERVICE}:-any:some_id`,
+    `prn:plate:1:${ServiceAbbreviation.CONTENT_MANAGEMENT_SERVICE}:-any:someId`,
   ])("accepts correct PRN string '%s'", async (prnString: string) => {
     // Act
     const result: boolean = prnRegex.test(prnString);
@@ -25,11 +25,11 @@ describe("PRN_REGEX", () => {
   });
 
   it.each([
-    `not-prn:plate:-1:${ServiceAbbreviation.EMAILS_SERVICE}:any:1234`,
-    `prn:plate:-1${ServiceAbbreviation.ACCESS_CONTROL}:too_little_components`,
-    `prn:plate:-1:${ServiceAbbreviation.ORGANIZATIONS_CENTER}:any:1234:too_many_components`,
-    `prn:plate:-1:${ServiceAbbreviation.CONTENT_EXPERIENCE_CENTER}:-any:`, // Empty component
-    `prn:plate:-1:${ServiceAbbreviation.CONTENT_EXPERIENCE_CENTER}:has white space:1234`,
+    `not-prn:plate:-1:${ServiceAbbreviation.PLATFORM_SERVICE}:any:1234`,
+    `prn:plate:-1${ServiceAbbreviation.PLATFORM_SERVICE}:too_little_components`,
+    `prn:plate:-1:${ServiceAbbreviation.PLATFORM_SERVICE}:any:1234:too_many_components`,
+    `prn:plate:-1:${ServiceAbbreviation.CONTENT_MANAGEMENT_SERVICE}:-any:`, // Empty component
+    `prn:plate:-1:${ServiceAbbreviation.CONTENT_MANAGEMENT_SERVICE}:has white space:1234`,
   ])("denies incorrect PRN string '%s'", async (prnString: string) => {
     // Act
     const result: boolean = prnRegex.test(prnString);

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

@@ -1,7 +1,4 @@
 export enum ServiceAbbreviation {
-  ASSET_MANAGER = "am",
-  CONTENT_EXPERIENCE_CENTER = "cxc",
-  ACCESS_CONTROL = "ac",
-  EMAILS_SERVICE = "es",
-  ORGANIZATIONS_CENTER = "oc",
+  CONTENT_MANAGEMENT_SERVICE = "cms",
+  PLATFORM_SERVICE = "ps",
 }

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

@@ -46,11 +46,11 @@ describe("TransformPrn", () => {
     }
 
     const testInstance = plainToInstance(TestClass, {
-      testProperty: "prn:plate:-1:cxc:content-field:id",
+      testProperty: "prn:plate:-1:cms:content-field:id",
     });
 
     expect(testInstance.testProperty).toBeInstanceOf(PRN);
-    expect(testInstance.testProperty.toString()).toStrictEqual("prn:plate:-1:cxc:content-field:id");
+    expect(testInstance.testProperty.toString()).toStrictEqual("prn:plate:-1:cms:content-field:id");
   });
 
   it("properly transforms an array of strings to an array of PRNs", () => {
@@ -60,14 +60,14 @@ describe("TransformPrn", () => {
     }
 
     const testInstance = plainToInstance(TestClass, {
-      testProperty: ["prn:plate:-1:cxc:content-field:id", "prn:plate:-1:cxc:content-field:title"],
+      testProperty: ["prn:plate:-1:cms:content-field:id", "prn:plate:-1:cms:content-field:title"],
     });
 
     expect(testInstance.testProperty).toBeInstanceOf(Array);
     expect(testInstance.testProperty[0]).toBeInstanceOf(PRN);
     expect(testInstance.testProperty[1]).toBeInstanceOf(PRN);
-    expect(testInstance.testProperty[0].toString()).toBe("prn:plate:-1:cxc:content-field:id");
-    expect(testInstance.testProperty[1].toString()).toBe("prn:plate:-1:cxc:content-field:title");
+    expect(testInstance.testProperty[0].toString()).toBe("prn:plate:-1:cms:content-field:id");
+    expect(testInstance.testProperty[1].toString()).toBe("prn:plate:-1:cms:content-field:title");
   });
 
   it("properly transforms a PRN to a string", () => {
@@ -77,10 +77,10 @@ describe("TransformPrn", () => {
     }
 
     const testInstance = new TestClass();
-    testInstance.testProperty = PRN.fromString("prn:plate:-1:cxc:content-field:id");
+    testInstance.testProperty = PRN.fromString("prn:plate:-1:cms:content-field:id");
 
     const plainObject = instanceToPlain(testInstance);
-    expect(plainObject.testProperty).toBe("prn:plate:-1:cxc:content-field:id");
+    expect(plainObject.testProperty).toBe("prn:plate:-1:cms:content-field:id");
   });
 
   it("properly transforms an array of PRNs to an array of strings", () => {
@@ -91,16 +91,16 @@ describe("TransformPrn", () => {
 
     const testInstance = new TestClass();
     testInstance.testProperty = [
-      PRN.fromString("prn:plate:-1:cxc:content-field:id"),
-      PRN.fromString("prn:plate:-1:cxc:content-field:title"),
+      PRN.fromString("prn:plate:-1:cms:content-field:id"),
+      PRN.fromString("prn:plate:-1:cms:content-field:title"),
     ];
 
     const plainObject = instanceToPlain(testInstance) as {
       testProperty: unknown[];
     };
     expect(plainObject.testProperty).toBeInstanceOf(Array);
-    expect(plainObject.testProperty[0]).toBe("prn:plate:-1:cxc:content-field:id");
-    expect(plainObject.testProperty[1]).toBe("prn:plate:-1:cxc:content-field:title");
+    expect(plainObject.testProperty[0]).toBe("prn:plate:-1:cms:content-field:id");
+    expect(plainObject.testProperty[1]).toBe("prn:plate:-1:cms:content-field:title");
   });
 
   it.each([{ prnValue: null }, { prnValue: undefined }])(