@productminds/article-events 5.2.0 → 6.0.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/ArticleEvent.d.ts

@@ -0,0 +1,70 @@
+import { Schema } from '@effect/schema';
+declare const _default: {
+    decode: (u: unknown, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }, import("@effect/schema/ParseResult").ParseError>;
+    decodeExn: (u: unknown) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    };
+    encode: (a: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly [x: string]: any;
+        };
+    }, import("@effect/schema/ParseResult").ParseError>;
+    encodeExn: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly [x: string]: any;
+        };
+    };
+    fromString: (msg: string) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }, import("@effect/schema/ParseResult").ParseError>;
+    fromBuffer: (msg: Buffer) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }, import("@effect/schema/ParseResult").ParseError>;
+    fromStringExn: (msg: string) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    };
+    fromBufferExn: (msg: Buffer) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    };
+    toString: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }) => string;
+    toBuffer: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }) => Buffer;
+    toStringExn: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }) => string;
+    toBufferExn: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: any;
+    }) => Buffer;
+    Schema: Schema.Struct<{
+        kind: Schema.Literal<["ARTICLE_EVENT"]>;
+        payload: Schema.Struct<{
+            article: any;
+            status: Schema.Literal<["NEW", "UPDATED"]>;
+            source: Schema.Literal<["INTERNAL", "EXTERNAL"]>;
+        }>;
+    }>;
+};
+export default _default;

package/lib/events/ArticleEvent.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@effect/schema");
+const Article_1 = require("../types/Article");
+const makeHelpers_1 = require("../utils/makeHelpers");
+const ArticleEventSchema = schema_1.Schema.Struct({
+    kind: schema_1.Schema.Literal('ARTICLE_EVENT'),
+    payload: schema_1.Schema.Struct({
+        article: Article_1.ArticleSchema,
+        status: schema_1.Schema.Literal('NEW', 'UPDATED'),
+        source: schema_1.Schema.Literal('INTERNAL', 'EXTERNAL'),
+    }),
+});
+const helpers = (0, makeHelpers_1.makeHelpers)(ArticleEventSchema);
+exports.default = Object.assign({ Schema: ArticleEventSchema }, helpers);

package/lib/events/ExternalArticleEvent.d.ts

@@ -7,7 +7,7 @@ export declare const ExternalArticleEventSchema: Schema.Struct<{
             url: typeof Schema.NonEmptyString;
             site: typeof Schema.NonEmptyString;
             content: typeof Schema.NonEmptyString;
-            retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+            retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
         }>, Schema.SchemaClass<{
             readonly title?: string | undefined;
             readonly teaser?: string | undefined;
@@ -424,7 +424,7 @@ declare const _default: {
                 url: typeof Schema.NonEmptyString;
                 site: typeof Schema.NonEmptyString;
                 content: typeof Schema.NonEmptyString;
-                retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+                retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
             }>, Schema.SchemaClass<{
                 readonly title?: string | undefined;
                 readonly teaser?: string | undefined;

package/lib/events/InternalArticleEvent.d.ts

@@ -1,15 +1,52 @@
 import { Schema } from '@effect/schema';
+export declare const ArticleUnpublishedSchema: Schema.Struct<{
+    status: Schema.Literal<["UNPUBLISHED"]>;
+    id: typeof Schema.NonEmptyString;
+    unpublishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, 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<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+        updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+        retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, 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;
+        }>]>>;
+    }>>;
+}>;
 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;
             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>;
+            publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+            updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+            retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
             url: typeof Schema.NonEmptyString;
             site: typeof Schema.NonEmptyString;
             authors: Schema.Array$<Schema.Struct<{
@@ -28,9 +65,11 @@ export declare const InternalArticleEventSchema: Schema.Struct<{
                 extSource: typeof Schema.String;
             }>]>>;
         }>>;
-        status: Schema.Literal<["NEW", "UPDATED"]>;
-        source: Schema.Literal<["INTERNAL"]>;
-    }>;
+    }>, Schema.Struct<{
+        status: Schema.Literal<["UNPUBLISHED"]>;
+        id: typeof Schema.NonEmptyString;
+        unpublishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+    }>]>;
 }>;
 declare const _default: {
     decode: (u: unknown, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
@@ -64,6 +103,10 @@ declare const _default: {
             };
             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) => {
@@ -97,6 +140,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     };
     encode: (a: {
@@ -130,6 +177,10 @@ declare const _default: {
             };
             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";
@@ -162,6 +213,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: string;
         };
     }, import("@effect/schema/ParseResult").ParseError>;
     encodeExn: (event: {
@@ -195,6 +250,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => {
         readonly kind: "INTERNAL_ARTICLE_EVENT";
@@ -227,6 +286,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: string;
         };
     };
     fromString: (msg: string) => import("effect/Either").Either<{
@@ -260,6 +323,10 @@ declare const _default: {
             };
             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<{
@@ -293,6 +360,10 @@ declare const _default: {
             };
             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) => {
@@ -326,6 +397,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     };
     fromBufferExn: (msg: Buffer) => {
@@ -359,6 +434,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     };
     toString: (event: {
@@ -392,6 +471,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => string;
     toBuffer: (event: {
@@ -425,6 +508,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => Buffer;
     toStringExn: (event: {
@@ -458,6 +545,10 @@ declare const _default: {
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
+        } | {
+            readonly id: string;
+            readonly status: "UNPUBLISHED";
+            readonly unpublishedAt: import("effect/DateTime").Utc;
         };
     }) => string;
     toBufferExn: (event: {
@@ -491,19 +582,25 @@ declare const _default: {
             };
             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;
                 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>;
+                publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+                updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+                retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
                 url: typeof Schema.NonEmptyString;
                 site: typeof Schema.NonEmptyString;
                 authors: Schema.Array$<Schema.Struct<{
@@ -522,9 +619,11 @@ declare const _default: {
                     extSource: typeof Schema.String;
                 }>]>>;
             }>>;
-            status: Schema.Literal<["NEW", "UPDATED"]>;
-            source: Schema.Literal<["INTERNAL"]>;
-        }>;
+        }>, Schema.Struct<{
+            status: Schema.Literal<["UNPUBLISHED"]>;
+            id: typeof Schema.NonEmptyString;
+            unpublishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+        }>]>;
     }>;
 };
 export default _default;

package/lib/events/InternalArticleEvent.js

@@ -1,19 +1,25 @@
 "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)),
 }));
+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/Article.d.ts

@@ -1,5 +1,5 @@
 import { Schema } from '@effect/schema';
-export declare const DateTimeSchema: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
+export declare const DateTimeSchema: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
 export declare const CategoryTagSchema: Schema.Struct<{
     type: Schema.Literal<["CATEGORY"]>;
     value: typeof Schema.NonEmptyString;
@@ -21,9 +21,9 @@ export declare const BaseArticleSchema: Schema.Struct<{
     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>;
+    publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+    updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
+    retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
     url: typeof Schema.NonEmptyString;
     site: typeof Schema.NonEmptyString;
     authors: Schema.Array$<Schema.Struct<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@productminds/article-events",
-  "version": "5.2.0",
+  "version": "6.0.0",
   "description": "Article events",
   "license": "ISC",
   "main": "lib/article-events.js",