@productminds/article-events 0.0.9 → 0.0.11

package/index.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/src/events/ArticleEvent.ts

@@ -1,19 +0,0 @@
-import { Schema } from '@effect/schema';
-import { ArticleSchema } from '../types/Article';
-
-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,
-  ...helpers
-};

package/src/events/ExternalArticleEvent.ts

@@ -1,19 +0,0 @@
-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,
-  ...helpers
-};

package/src/events/InternalArticleEvent.ts

@@ -1,19 +0,0 @@
-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,
-  ...helpers
-};

package/src/types/Article.ts

@@ -1,46 +0,0 @@
-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

@@ -1,55 +0,0 @@
-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
-  };
-};

package/tsconfig.json

@@ -1,100 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-    /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-    /* Language and Environment */
-    "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-    /* Modules */
-    "module": "commonjs", /* Specify what module code is generated. */
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
-    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
-    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
-    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-    /* Emit */
-    "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "./dist", /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
-    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
-    /* Type Checking */
-    "strict": true, /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
-    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
-    "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
-    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true /* Skip type checking all .d.ts files. */
-  }
-}