@productminds/article-events 0.0.9 → 0.0.11

package/README.md

@@ -0,0 +1,11 @@
+# `article-events`
+
+> TODO: description
+
+## Usage
+
+```
+const articleEvents = require('article-events');
+
+// TODO: DEMONSTRATE API
+```

package/lib/article-events.d.ts

@@ -0,0 +1,4 @@
+import ArticleEvent from './events/ArticleEvent';
+import ExternalArticleEvent from './events/ExternalArticleEvent';
+import InternalArticleEvent from './events/InternalArticleEvent';
+export { ArticleEvent, ExternalArticleEvent, InternalArticleEvent };

package/lib/article-events.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalArticleEvent = exports.ExternalArticleEvent = exports.ArticleEvent = void 0;
+const ArticleEvent_1 = __importDefault(require("./events/ArticleEvent"));
+exports.ArticleEvent = ArticleEvent_1.default;
+const ExternalArticleEvent_1 = __importDefault(require("./events/ExternalArticleEvent"));
+exports.ExternalArticleEvent = ExternalArticleEvent_1.default;
+const InternalArticleEvent_1 = __importDefault(require("./events/InternalArticleEvent"));
+exports.InternalArticleEvent = InternalArticleEvent_1.default;

package/lib/cmd/write-json-schema.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cmd/write-json-schema.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@effect/schema");
+const InternalArticleEvent_1 = require("../events/InternalArticleEvent");
+const ExternalArticleEvent_1 = require("../events/ExternalArticleEvent");
+const fs_1 = require("fs");
+const dir = "./jsonSchemas";
+if (!(0, fs_1.existsSync)(dir)) {
+    (0, fs_1.mkdirSync)(dir);
+}
+const jsonSchemaInternal = schema_1.JSONSchema.make(InternalArticleEvent_1.InternalArticleEventSchema);
+(0, fs_1.writeFileSync)(`${dir}/internalArticleEventSchema.json`, JSON.stringify(jsonSchemaInternal, null, 2));
+const jsonSchemaExternal = schema_1.JSONSchema.make(ExternalArticleEvent_1.ExternalArticleEventSchema);
+(0, fs_1.writeFileSync)(`${dir}/externalArticleEventSchema.json`, JSON.stringify(jsonSchemaExternal, null, 2));

package/lib/events/ArticleEvent.d.ts

@@ -0,0 +1,482 @@
+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: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }, import("@effect/schema/ParseResult").ParseError>;
+    decodeExn: (u: unknown) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    };
+    encode: (a: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: string;
+                readonly updatedAt: string;
+                readonly retrievedAt: string;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }, import("@effect/schema/ParseResult").ParseError>;
+    encodeExn: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: string;
+                readonly updatedAt: string;
+                readonly retrievedAt: string;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    };
+    fromString: (msg: string) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }, import("@effect/schema/ParseResult").ParseError>;
+    fromBuffer: (msg: Buffer) => import("effect/Either").Either<{
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }, import("@effect/schema/ParseResult").ParseError>;
+    fromStringExn: (msg: string) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    };
+    fromBufferExn: (msg: Buffer) => {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    };
+    toString: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }) => string;
+    toBuffer: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }) => Buffer;
+    toStringExn: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }) => string;
+    toBufferExn: (event: {
+        readonly kind: "ARTICLE_EVENT";
+        readonly payload: {
+            readonly article: {
+                readonly id: string;
+                readonly site: string;
+                readonly title: string;
+                readonly teaser: string;
+                readonly content: string;
+                readonly publishedAt: Date;
+                readonly updatedAt: Date;
+                readonly retrievedAt: Date;
+                readonly url: string;
+                readonly tags: readonly ({
+                    readonly type: "CATEGORY";
+                    readonly value: string;
+                } | {
+                    readonly type: "EXTERNAL_ARTICLE_REFERENCE";
+                    readonly id: string;
+                } | {
+                    readonly type: "ENTITY";
+                    readonly value: string;
+                    readonly entityType: "PERSON";
+                })[];
+                readonly authors: readonly {
+                    readonly name: string;
+                }[];
+            };
+            readonly status: "NEW" | "UPDATED";
+            readonly source: "INTERNAL" | "EXTERNAL";
+        };
+    }) => Buffer;
+    Schema: Schema.Struct<{
+        kind: Schema.Literal<["ARTICLE_EVENT"]>;
+        payload: Schema.Struct<{
+            article: Schema.Struct<{
+                id: typeof Schema.UUID;
+                title: typeof Schema.NonEmpty;
+                teaser: typeof Schema.NonEmpty;
+                content: typeof Schema.NonEmpty;
+                publishedAt: typeof Schema.Date;
+                updatedAt: typeof Schema.Date;
+                retrievedAt: typeof Schema.Date;
+                url: typeof Schema.NonEmpty;
+                site: typeof Schema.NonEmpty;
+                tags: Schema.Array$<Schema.Union<[Schema.Struct<{
+                    type: Schema.Literal<["CATEGORY"]>;
+                    value: typeof Schema.NonEmpty;
+                }>, Schema.Struct<{
+                    type: Schema.Literal<["EXTERNAL_ARTICLE_REFERENCE"]>;
+                    id: typeof Schema.UUID;
+                }>, Schema.Struct<{
+                    type: Schema.Literal<["ENTITY"]>;
+                    entityType: Schema.Literal<["PERSON"]>;
+                    value: typeof Schema.NonEmpty;
+                }>]>>;
+                authors: Schema.Array$<Schema.Struct<{
+                    name: typeof Schema.NonEmpty;
+                }>>;
+            }>;
+            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);