@productminds/article-events 0.0.1 → 0.0.2

package/index.ts

@@ -1,84 +1,3 @@
-import { Schema } from '@effect/schema';
-
-const DateTimeSchema = Schema.Date.annotations({
-  jsonSchema: { format: 'date-time' }
-});
-
-const CategoryTagSchema = Schema.Struct({
-  type: Schema.Literal('category'),
-  value: Schema.NonEmpty
-});
-
-const ArticleReferenceSchema = Schema.Struct({
-  type: Schema.Literal('articleReference'),
-  id: Schema.UUID
-});
-
-const TagSchema = Schema.Union(CategoryTagSchema, ArticleReferenceSchema);
-
-const AuthorSchema = Schema.Struct({
-  name: Schema.NonEmpty
-});
-
-export const ArticleSchema = Schema.Struct({
-  id: Schema.UUID,
-  title: Schema.NonEmpty,
-  teaser: Schema.NonEmpty,
-  content: Schema.NonEmpty,
-  publishedAt: DateTimeSchema,
-  updatedAt: DateTimeSchema,
-  retrievedAt: DateTimeSchema,
-  url: Schema.NonEmpty,
-  site: Schema.NonEmpty,
-  tags: Schema.Array(TagSchema),
-  authors: Schema.Array(AuthorSchema),
-  meta: Schema.optional(Schema.Unknown)
-});
-
-export const ArticleEventSchema = Schema.Struct({
-  kind: Schema.Literal('ARTICLE_EVENT'),
-  payload: Schema.Struct({
-    article: ArticleSchema,
-    status: Schema.Literal('NEW', 'UPDATED'),
-    source: Schema.Literal('INTERNAL', 'EXTERNAL')
-  })
-});
-
-export const decode = Schema.decodeUnknownEither(ArticleEventSchema);
-export const decodeExn = (u: unknown) => {
-  const decoded = decode(u);
-
-  if (decoded._tag === 'Left') {
-    throw new Error('Failed to decode ArticleEvent');
-  }
-
-  return decoded.right;
-};
-
-export const encode = Schema.encodeEither(ArticleEventSchema);
-export const encodeExn = (event: typeof ArticleEventSchema.Type) => {
-  const encoded = encode(event);
-
-  if (encoded._tag === 'Left') {
-    throw new Error('Failed to encode ArticleEvent');
-  }
-
-  return encoded.right;
-};
-
-export const fromString = (msg: string) => decode(JSON.parse(msg));
-export const fromBuffer = (msg: Buffer) => decode(JSON.parse(msg.toString()));
-
-export const fromStringExn = (msg: string) => decodeExn(JSON.parse(msg));
-export const fromBufferExn = (msg: Buffer) => fromStringExn(msg.toString());
-
-export const toString = (event: typeof ArticleEventSchema.Type) =>
-  JSON.stringify(encode(event));
-
-export const toBuffer = (event: typeof ArticleEventSchema.Type) =>
-  Buffer.from(toString(event));
-
-export const toStringExn = (event: typeof ArticleEventSchema.Type) =>
-  JSON.stringify(encodeExn(event));
-export const toBufferExn = (event: typeof ArticleEventSchema.Type) =>
-  Buffer.from(toStringExn(event));
+export * from './src/events/ArticleEvent';
+export * from './src/events/ExternalArticleEvent';
+export * from './src/events/InternalArticleEvent';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@productminds/article-events",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/events/ArticleEvent.ts

@@ -0,0 +1,19 @@
+import { Schema } from '@effect/schema';
+import { ArticleSchema } from '../types/Article';
+
+export const ArticleEventSchema = Schema.Struct({
+  kind: Schema.Literal('ARTICLE_EVENT'),
+  payload: Schema.Struct({
+    article: ArticleSchema,
+    status: Schema.Literal('NEW', 'UPDATED'),
+    source: Schema.Literal('INTERNAL', 'EXTERNAL')
+  })
+});
+
+import { makeHelpers } from '../utils/makeHelpers';
+const helpers = makeHelpers(ArticleEventSchema);
+
+export default {
+  Schema: ArticleEventSchema,
+  ...makeHelpers
+};

package/src/events/ExternalArticleEvent.ts

@@ -0,0 +1,19 @@
+import { Schema } from '@effect/schema';
+import { ArticleSchema } from '../types/Article';
+
+export const ExternalArticleEventSchema = Schema.Struct({
+  kind: Schema.Literal('EXTERNAL_ARTICLE_EVENT'),
+  payload: Schema.Struct({
+    article: ArticleSchema,
+    status: Schema.Literal('NEW', 'UPDATED'),
+    source: Schema.Literal('EXTERNAL')
+  })
+});
+
+import { makeHelpers } from '../utils/makeHelpers';
+const helpers = makeHelpers(ExternalArticleEventSchema);
+
+export default {
+  Schema: ExternalArticleEventSchema,
+  ...makeHelpers
+};

package/src/events/InternalArticleEvent.ts

@@ -0,0 +1,19 @@
+import { Schema } from '@effect/schema';
+import { ArticleSchema } from '../types/Article';
+
+export const InternalArticleEvent = Schema.Struct({
+  kind: Schema.Literal('INTERNAL_ARTICLE_EVENT'),
+  payload: Schema.Struct({
+    article: ArticleSchema,
+    status: Schema.Literal('NEW', 'UPDATED'),
+    source: Schema.Literal('INTERNAL')
+  })
+});
+
+import { makeHelpers } from '../utils/makeHelpers';
+const helpers = makeHelpers(InternalArticleEvent);
+
+export default {
+  Schema: InternalArticleEvent,
+  ...makeHelpers
+};

package/src/types/Article.ts

@@ -0,0 +1,46 @@
+import { Schema } from '@effect/schema';
+
+export const DateTimeSchema = Schema.Date.annotations({
+  jsonSchema: { format: 'date-time' }
+});
+
+export const CategoryTagSchema = Schema.Struct({
+  type: Schema.Literal('CATEGORY'),
+  value: Schema.NonEmpty
+});
+
+export const ArticleReferenceSchema = Schema.Struct({
+  type: Schema.Literal('EXTERNAL_ARTICLE_REFERENCE'),
+  id: Schema.UUID
+});
+
+export const EntityTag = Schema.Struct({
+  type: Schema.Literal('ENTITY'),
+  entityType: Schema.Literal('PERSON'),
+  value: Schema.NonEmpty
+});
+
+export const TagSchema = Schema.Union(
+  CategoryTagSchema,
+  ArticleReferenceSchema,
+  EntityTag
+);
+
+export const AuthorSchema = Schema.Struct({
+  name: Schema.NonEmpty
+});
+
+export const ArticleSchema = Schema.Struct({
+  id: Schema.UUID,
+  title: Schema.NonEmpty,
+  teaser: Schema.NonEmpty,
+  content: Schema.NonEmpty,
+  publishedAt: DateTimeSchema,
+  updatedAt: DateTimeSchema,
+  retrievedAt: DateTimeSchema,
+  url: Schema.NonEmpty,
+  site: Schema.NonEmpty,
+  tags: Schema.Array(TagSchema),
+  authors: Schema.Array(AuthorSchema),
+  meta: Schema.optional(Schema.Unknown)
+});

package/src/utils/makeHelpers.ts

@@ -0,0 +1,55 @@
+import { Schema } from '@effect/schema';
+
+export const makeHelpers = <A, I>(schema: Schema.Schema<A, I, never>) => {
+  const decode = Schema.decodeUnknownEither(schema);
+  const decodeExn = (u: unknown) => {
+    const decoded = decode(u);
+
+    if (decoded._tag === 'Left') {
+      throw new Error('Failed to decode ArticleEvent');
+    }
+
+    return decoded.right;
+  };
+
+  const encode = Schema.encodeEither(schema);
+  const encodeExn = (event: typeof schema.Type) => {
+    const encoded = encode(event);
+
+    if (encoded._tag === 'Left') {
+      throw new Error('Failed to encode ArticleEvent');
+    }
+
+    return encoded.right;
+  };
+
+  const fromString = (msg: string) => decode(JSON.parse(msg));
+  const fromBuffer = (msg: Buffer) => decode(JSON.parse(msg.toString()));
+
+  const fromStringExn = (msg: string) => decodeExn(JSON.parse(msg));
+  const fromBufferExn = (msg: Buffer) => fromStringExn(msg.toString());
+
+  const toString = (event: typeof schema.Type) => JSON.stringify(encode(event));
+
+  const toBuffer = (event: typeof schema.Type) => Buffer.from(toString(event));
+
+  const toStringExn = (event: typeof schema.Type) =>
+    JSON.stringify(encodeExn(event));
+  const toBufferExn = (event: typeof schema.Type) =>
+    Buffer.from(toStringExn(event));
+
+  return {
+    decode,
+    decodeExn,
+    encode,
+    encodeExn,
+    fromString,
+    fromBuffer,
+    fromStringExn,
+    fromBufferExn,
+    toString,
+    toBuffer,
+    toStringExn,
+    toBufferExn
+  };
+};