@productminds/article-events 5.2.0 → 6.2.0

package/lib/article-events/src/utils/makeHelpers.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeHelpers = void 0;
+const schema_1 = require("@effect/schema");
+const makeHelpers = (schema) => {
+    const decode = schema_1.Schema.decodeUnknownEither(schema);
+    const decodeExn = (u) => {
+        const decoded = decode(u);
+        if (decoded._tag === 'Left') {
+            throw new Error('Failed to decode ArticleEvent');
+        }
+        return decoded.right;
+    };
+    const encode = schema_1.Schema.encodeEither(schema);
+    const encodeExn = (event) => {
+        const encoded = encode(event);
+        if (encoded._tag === 'Left') {
+            throw new Error('Failed to encode ArticleEvent');
+        }
+        return encoded.right;
+    };
+    const fromString = (msg) => decode(JSON.parse(msg));
+    const fromBuffer = (msg) => decode(JSON.parse(msg.toString()));
+    const fromStringExn = (msg) => decodeExn(JSON.parse(msg));
+    const fromBufferExn = (msg) => fromStringExn(msg.toString());
+    const toString = (event) => JSON.stringify(encode(event));
+    const toBuffer = (event) => Buffer.from(toString(event));
+    const toStringExn = (event) => JSON.stringify(encodeExn(event));
+    const toBufferExn = (event) => Buffer.from(toStringExn(event));
+    return {
+        decode,
+        decodeExn,
+        encode,
+        encodeExn,
+        fromString,
+        fromBuffer,
+        fromStringExn,
+        fromBufferExn,
+        toString,
+        toBuffer,
+        toStringExn,
+        toBufferExn,
+    };
+};
+exports.makeHelpers = makeHelpers;

package/lib/events/InternalArticleEvent.d.ts

@@ -1,7 +1,45 @@
 import { Schema } from '@effect/schema';
+export declare const ArticleUnpublishedSchema: Schema.Struct<{
+    status: Schema.Literal<["UNPUBLISHED"]>;
+    id: typeof Schema.NonEmptyString;
+    unpublishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+}>;
+export declare const ArticleIngressSchema: Schema.Struct<{
+    source: Schema.Literal<["INTERNAL"]>;
+    status: Schema.Literal<["NEW", "UPDATED"]>;
+    article: Schema.extend<Schema.Struct<{
+        id: typeof Schema.NonEmptyString;
+        title: typeof Schema.NonEmptyString;
+        teaser: typeof Schema.NonEmptyString;
+        content: typeof Schema.NonEmptyString;
+        publishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+        updatedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+        retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+        url: typeof Schema.NonEmptyString;
+        site: typeof Schema.NonEmptyString;
+        authors: Schema.Array$<Schema.Struct<{
+            name: typeof Schema.NonEmptyString;
+        }>>;
+    }>, Schema.Struct<{
+        tags: Schema.Array$<Schema.Union<[Schema.Struct<{
+            type: Schema.Literal<["CATEGORY"]>;
+            value: typeof Schema.NonEmptyString;
+        }>, Schema.Struct<{
+            type: Schema.Literal<["EXTERNAL_ARTICLE_REFERENCE"]>;
+            id: typeof Schema.NonEmptyString;
+        }>, Schema.Struct<{
+            type: Schema.Literal<["DRUPAL_EXTERNAL_ID"]>;
+            extID: typeof Schema.UUID;
+            extSource: typeof Schema.String;
+        }>]>>;
+        reusePolicy: Schema.optional<Schema.Literal<["strictly_no_reuse", "by_request", "free_to_reuse"]>>;
+    }>>;
+}>;
 export declare const InternalArticleEventSchema: Schema.Struct<{
     kind: Schema.Literal<["INTERNAL_ARTICLE_EVENT"]>;
-    payload: Schema.Struct<{
+    payload: Schema.Union<[Schema.Struct<{
+        source: Schema.Literal<["INTERNAL"]>;
+        status: Schema.Literal<["NEW", "UPDATED"]>;
         article: Schema.extend<Schema.Struct<{
             id: typeof Schema.NonEmptyString;
             title: typeof Schema.NonEmptyString;
@@ -27,10 +65,13 @@ export declare const InternalArticleEventSchema: Schema.Struct<{
                 extID: typeof Schema.UUID;
                 extSource: typeof Schema.String;
             }>]>>;
+            reusePolicy: Schema.optional<Schema.Literal<["strictly_no_reuse", "by_request", "free_to_reuse"]>>;
         }>>;
-        status: Schema.Literal<["NEW", "UPDATED"]>;
-        source: Schema.Literal<["INTERNAL"]>;
-    }>;
+    }>, Schema.Struct<{
+        status: Schema.Literal<["UNPUBLISHED"]>;
+        id: typeof Schema.NonEmptyString;
+        unpublishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+    }>]>;
 }>;
 declare const _default: {
     decode: (u: unknown, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
@@ -61,9 +102,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }, import("@effect/schema/ParseResult").ParseError>;
     decodeExn: (u: unknown) => {
@@ -94,9 +140,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     };
     encode: (a: {
@@ -127,9 +178,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
         readonly kind: "INTERNAL_ARTICLE_EVENT";
@@ -159,9 +215,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: string;
         };
     }, import("@effect/schema/ParseResult").ParseError>;
     encodeExn: (event: {
@@ -192,9 +253,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => {
         readonly kind: "INTERNAL_ARTICLE_EVENT";
@@ -224,9 +290,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: string;
         };
     };
     fromString: (msg: string) => import("effect/Either").Either<{
@@ -257,9 +328,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }, import("@effect/schema/ParseResult").ParseError>;
     fromBuffer: (msg: Buffer) => import("effect/Either").Either<{
@@ -290,9 +366,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }, import("@effect/schema/ParseResult").ParseError>;
     fromStringExn: (msg: string) => {
@@ -323,9 +404,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     };
     fromBufferExn: (msg: Buffer) => {
@@ -356,9 +442,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     };
     toString: (event: {
@@ -389,9 +480,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => string;
     toBuffer: (event: {
@@ -422,9 +518,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => Buffer;
     toStringExn: (event: {
@@ -455,9 +556,14 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => string;
     toBufferExn: (event: {
@@ -488,14 +594,21 @@ declare const _default: {
                     readonly type: "EXTERNAL_ARTICLE_REFERENCE";
                     readonly id: string;
                 })[];
+                readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => Buffer;
     Schema: Schema.Struct<{
         kind: Schema.Literal<["INTERNAL_ARTICLE_EVENT"]>;
-        payload: Schema.Struct<{
+        payload: Schema.Union<[Schema.Struct<{
+            source: Schema.Literal<["INTERNAL"]>;
+            status: Schema.Literal<["NEW", "UPDATED"]>;
             article: Schema.extend<Schema.Struct<{
                 id: typeof Schema.NonEmptyString;
                 title: typeof Schema.NonEmptyString;
@@ -521,10 +634,13 @@ declare const _default: {
                     extID: typeof Schema.UUID;
                     extSource: typeof Schema.String;
                 }>]>>;
+                reusePolicy: Schema.optional<Schema.Literal<["strictly_no_reuse", "by_request", "free_to_reuse"]>>;
             }>>;
-            status: Schema.Literal<["NEW", "UPDATED"]>;
-            source: Schema.Literal<["INTERNAL"]>;
-        }>;
+        }>, Schema.Struct<{
+            status: Schema.Literal<["UNPUBLISHED"]>;
+            id: typeof Schema.NonEmptyString;
+            unpublishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+        }>]>;
     }>;
 };
 export default _default;

package/lib/events/InternalArticleEvent.js

@@ -1,19 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalArticleEventSchema = void 0;
+exports.InternalArticleEventSchema = exports.ArticleIngressSchema = exports.ArticleUnpublishedSchema = void 0;
 const schema_1 = require("@effect/schema");
 const Article_1 = require("../types/Article");
 const makeHelpers_1 = require("../utils/makeHelpers");
 const InternalArticleSchema = schema_1.Schema.extend(Article_1.BaseArticleSchema, schema_1.Schema.Struct({
     tags: schema_1.Schema.Array(schema_1.Schema.Union(Article_1.CategoryTagSchema, Article_1.ExternalArticleReferenceTagSchema, Article_1.DrupalExternalIDTag)),
+    reusePolicy: schema_1.Schema.optional(schema_1.Schema.Literal('strictly_no_reuse', 'by_request', 'free_to_reuse')),
 }));
+exports.ArticleUnpublishedSchema = schema_1.Schema.Struct({
+    status: schema_1.Schema.Literal('UNPUBLISHED'),
+    id: schema_1.Schema.NonEmptyString,
+    unpublishedAt: Article_1.DateTimeSchema,
+});
+exports.ArticleIngressSchema = schema_1.Schema.Struct({
+    source: schema_1.Schema.Literal('INTERNAL'),
+    status: schema_1.Schema.Literal('NEW', 'UPDATED'),
+    article: InternalArticleSchema,
+});
 exports.InternalArticleEventSchema = schema_1.Schema.Struct({
     kind: schema_1.Schema.Literal('INTERNAL_ARTICLE_EVENT'),
-    payload: schema_1.Schema.Struct({
-        article: InternalArticleSchema,
-        status: schema_1.Schema.Literal('NEW', 'UPDATED'),
-        source: schema_1.Schema.Literal('INTERNAL'),
-    }),
+    payload: schema_1.Schema.Union(exports.ArticleIngressSchema, exports.ArticleUnpublishedSchema),
 });
 const helpers = (0, makeHelpers_1.makeHelpers)(exports.InternalArticleEventSchema);
 exports.default = Object.assign({ Schema: exports.InternalArticleEventSchema }, helpers);

package/lib/shared/schema.d.ts

@@ -0,0 +1,2 @@
+import { Schema } from "@effect/schema";
+export declare const InternalArticleIDSchema: typeof Schema.NonEmptyString;

package/lib/shared/schema.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalArticleIDSchema = void 0;
+const schema_1 = require("@effect/schema");
+exports.InternalArticleIDSchema = schema_1.Schema.NonEmptyString;

package/lib/types/ReusePolicy.d.ts

@@ -0,0 +1,2 @@
+import { Schema } from '@effect/schema';
+export declare const ReusePolicySchema: Schema.Struct<{}>;

package/lib/types/ReusePolicy.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReusePolicySchema = void 0;
+const schema_1 = require("@effect/schema");
+exports.ReusePolicySchema = schema_1.Schema.Struct({});

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@productminds/article-events",
-  "version": "5.2.0",
-  "description": "Article events",
-  "license": "ISC",
-  "main": "lib/article-events.js",
-  "typings": "lib/article-events.d.ts",
-  "directories": {
-    "lib": "lib"
-  },
-  "files": [
-    "lib"
-  ],
-  "scripts": {
-    "cmd:generate_json_schema": "tsc && node ./lib/cmd/write-json-schema.js",
-    "build": "tsc",
-    "build:watch": "tsc --watch",
-    "build_and_publish": "npm run build && npm publish"
-  }
-}
+{
+  "name": "@productminds/article-events",
+  "version": "6.2.0",
+  "description": "Article events",
+  "license": "ISC",
+  "main": "lib/article-events.js",
+  "typings": "lib/article-events.d.ts",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "cmd:generate_json_schema": "tsc && node ./lib/cmd/write-json-schema.js",
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "build_and_publish": "npm run build && npm publish"
+  }
+}