@productminds/article-events 0.0.10 → 1.0.0

package/{dist/src → lib}/events/InternalArticleEvent.d.ts

@@ -1,8 +1,8 @@
 import { Schema } from '@effect/schema';
-export declare const InternalArticleEvent: Schema.Struct<{
+export declare const InternalArticleEventSchema: Schema.Struct<{
     kind: Schema.Literal<["INTERNAL_ARTICLE_EVENT"]>;
     payload: Schema.Struct<{
-        article: Schema.Struct<{
+        article: Schema.extend<Schema.Struct<{
             id: typeof Schema.UUID;
             title: typeof Schema.NonEmpty;
             teaser: typeof Schema.NonEmpty;
@@ -12,22 +12,18 @@ export declare const InternalArticleEvent: Schema.Struct<{
             retrievedAt: typeof Schema.Date;
             url: typeof Schema.NonEmpty;
             site: typeof Schema.NonEmpty;
+            authors: Schema.Array$<Schema.Struct<{
+                name: typeof Schema.NonEmpty;
+            }>>;
+        }>, Schema.Struct<{
             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;
-            }>>;
-            meta: Schema.optional<typeof Schema.Unknown>;
-        }>;
+        }>>;
         status: Schema.Literal<["NEW", "UPDATED"]>;
         source: Schema.Literal<["INTERNAL"]>;
     }>;
@@ -46,21 +42,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -79,21 +71,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -112,21 +100,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -144,21 +128,17 @@ declare const _default: {
                 readonly retrievedAt: string;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -177,21 +157,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -209,21 +185,17 @@ declare const _default: {
                 readonly retrievedAt: string;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -242,21 +214,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -275,21 +243,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -308,21 +272,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -341,21 +301,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -374,21 +330,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -407,21 +359,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -440,21 +388,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -473,21 +417,17 @@ declare const _default: {
                 readonly retrievedAt: Date;
                 readonly url: string;
                 readonly site: string;
+                readonly authors: readonly {
+                    readonly name: 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 meta?: unknown;
             };
             readonly status: "NEW" | "UPDATED";
             readonly source: "INTERNAL";
@@ -496,7 +436,7 @@ declare const _default: {
     Schema: Schema.Struct<{
         kind: Schema.Literal<["INTERNAL_ARTICLE_EVENT"]>;
         payload: Schema.Struct<{
-            article: Schema.Struct<{
+            article: Schema.extend<Schema.Struct<{
                 id: typeof Schema.UUID;
                 title: typeof Schema.NonEmpty;
                 teaser: typeof Schema.NonEmpty;
@@ -506,22 +446,18 @@ declare const _default: {
                 retrievedAt: typeof Schema.Date;
                 url: typeof Schema.NonEmpty;
                 site: typeof Schema.NonEmpty;
+                authors: Schema.Array$<Schema.Struct<{
+                    name: typeof Schema.NonEmpty;
+                }>>;
+            }>, Schema.Struct<{
                 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;
-                }>>;
-                meta: Schema.optional<typeof Schema.Unknown>;
-            }>;
+            }>>;
             status: Schema.Literal<["NEW", "UPDATED"]>;
             source: Schema.Literal<["INTERNAL"]>;
         }>;

package/{dist/src → lib}/events/InternalArticleEvent.js

@@ -1,16 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalArticleEvent = void 0;
+exports.InternalArticleEventSchema = void 0;
 const schema_1 = require("@effect/schema");
 const Article_1 = require("../types/Article");
-exports.InternalArticleEvent = schema_1.Schema.Struct({
+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)),
+}));
+exports.InternalArticleEventSchema = schema_1.Schema.Struct({
     kind: schema_1.Schema.Literal('INTERNAL_ARTICLE_EVENT'),
     payload: schema_1.Schema.Struct({
-        article: Article_1.ArticleSchema,
+        article: InternalArticleSchema,
         status: schema_1.Schema.Literal('NEW', 'UPDATED'),
-        source: schema_1.Schema.Literal('INTERNAL')
-    })
+        source: schema_1.Schema.Literal('INTERNAL'),
+    }),
 });
-const makeHelpers_1 = require("../utils/makeHelpers");
-const helpers = (0, makeHelpers_1.makeHelpers)(exports.InternalArticleEvent);
-exports.default = Object.assign({ Schema: exports.InternalArticleEvent }, helpers);
+const helpers = (0, makeHelpers_1.makeHelpers)(exports.InternalArticleEventSchema);
+exports.default = Object.assign({ Schema: exports.InternalArticleEventSchema }, helpers);

package/lib/types/Article.d.ts

@@ -0,0 +1,27 @@
+import { Schema } from '@effect/schema';
+export declare const DateTimeSchema: typeof Schema.Date;
+export declare const CategoryTagSchema: Schema.Struct<{
+    type: Schema.Literal<["CATEGORY"]>;
+    value: typeof Schema.NonEmpty;
+}>;
+export declare const ExternalArticleReferenceTagSchema: Schema.Struct<{
+    type: Schema.Literal<["EXTERNAL_ARTICLE_REFERENCE"]>;
+    id: typeof Schema.UUID;
+}>;
+export declare const AuthorSchema: Schema.Struct<{
+    name: typeof Schema.NonEmpty;
+}>;
+export declare const BaseArticleSchema: 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;
+    authors: Schema.Array$<Schema.Struct<{
+        name: typeof Schema.NonEmpty;
+    }>>;
+}>;

package/lib/types/Article.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseArticleSchema = exports.AuthorSchema = exports.ExternalArticleReferenceTagSchema = exports.CategoryTagSchema = exports.DateTimeSchema = void 0;
+const schema_1 = require("@effect/schema");
+exports.DateTimeSchema = schema_1.Schema.Date.annotations({
+    jsonSchema: { format: 'date-time' },
+});
+exports.CategoryTagSchema = schema_1.Schema.Struct({
+    type: schema_1.Schema.Literal('CATEGORY'),
+    value: schema_1.Schema.NonEmpty,
+});
+exports.ExternalArticleReferenceTagSchema = schema_1.Schema.Struct({
+    type: schema_1.Schema.Literal('EXTERNAL_ARTICLE_REFERENCE'),
+    id: schema_1.Schema.UUID,
+});
+exports.AuthorSchema = schema_1.Schema.Struct({
+    name: schema_1.Schema.NonEmpty,
+});
+exports.BaseArticleSchema = schema_1.Schema.Struct({
+    id: schema_1.Schema.UUID,
+    title: schema_1.Schema.NonEmpty,
+    teaser: schema_1.Schema.NonEmpty,
+    content: schema_1.Schema.NonEmpty,
+    publishedAt: exports.DateTimeSchema,
+    updatedAt: exports.DateTimeSchema,
+    retrievedAt: exports.DateTimeSchema,
+    url: schema_1.Schema.NonEmpty,
+    site: schema_1.Schema.NonEmpty,
+    authors: schema_1.Schema.Array(exports.AuthorSchema),
+});

package/{dist/src → lib}/utils/makeHelpers.js

@@ -39,7 +39,7 @@ const makeHelpers = (schema) => {
         toString,
         toBuffer,
         toStringExn,
-        toBufferExn
+        toBufferExn,
     };
 };
 exports.makeHelpers = makeHelpers;

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@productminds/article-events",
-  "version": "0.0.10",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "1.0.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",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "mbirkegaard",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/node": "^20.14.11",
-    "typescript": "^5.5.3"
-  },
-  "dependencies": {
-    "@effect/schema": "^0.68.26"
+    "build_and_publish": "npm run build && npm publish"
   }
 }

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * as ArticleEvent from './src/events/ArticleEvent';
-export * as ExternalArticleEvent from './src/events/ExternalArticleEvent';
-export * as InternalArticleEvent from './src/events/InternalArticleEvent';

package/dist/index.js

@@ -1,29 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalArticleEvent = exports.ExternalArticleEvent = exports.ArticleEvent = void 0;
-exports.ArticleEvent = __importStar(require("./src/events/ArticleEvent"));
-exports.ExternalArticleEvent = __importStar(require("./src/events/ExternalArticleEvent"));
-exports.InternalArticleEvent = __importStar(require("./src/events/InternalArticleEvent"));