@productminds/article-events 6.2.0 → 6.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +11 -11
  2. package/lib/events/ArticleEvent.d.ts +70 -0
  3. package/lib/events/ArticleEvent.js +15 -0
  4. package/lib/events/ExternalArticleEvent.d.ts +2 -2
  5. package/lib/events/InternalArticleEvent.d.ts +29 -12
  6. package/lib/events/InternalArticleEvent.js +1 -0
  7. package/lib/types/Article.d.ts +4 -4
  8. package/package.json +20 -20
package/README.md CHANGED
@@ -1,11 +1,11 @@
1
- # `article-events`
2
-
3
- > TODO: description
4
-
5
- ## Usage
6
-
7
- ```
8
- const articleEvents = require('article-events');
9
-
10
- // TODO: DEMONSTRATE API
11
- ```
1
+ # `article-events`
2
+
3
+ > TODO: description
4
+
5
+ ## Usage
6
+
7
+ ```
8
+ const articleEvents = require('article-events');
9
+
10
+ // TODO: DEMONSTRATE API
11
+ ```
package/lib/events/ArticleEvent.d.ts ADDED
@@ -0,0 +1,70 @@
1
+ import { Schema } from '@effect/schema';
2
+ declare const _default: {
3
+ decode: (u: unknown, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
4
+ readonly kind: "ARTICLE_EVENT";
5
+ readonly payload: any;
6
+ }, import("@effect/schema/ParseResult").ParseError>;
7
+ decodeExn: (u: unknown) => {
8
+ readonly kind: "ARTICLE_EVENT";
9
+ readonly payload: any;
10
+ };
11
+ encode: (a: {
12
+ readonly kind: "ARTICLE_EVENT";
13
+ readonly payload: any;
14
+ }, overrideOptions?: import("@effect/schema/AST").ParseOptions) => import("effect/Either").Either<{
15
+ readonly kind: "ARTICLE_EVENT";
16
+ readonly payload: {
17
+ readonly [x: string]: any;
18
+ };
19
+ }, import("@effect/schema/ParseResult").ParseError>;
20
+ encodeExn: (event: {
21
+ readonly kind: "ARTICLE_EVENT";
22
+ readonly payload: any;
23
+ }) => {
24
+ readonly kind: "ARTICLE_EVENT";
25
+ readonly payload: {
26
+ readonly [x: string]: any;
27
+ };
28
+ };
29
+ fromString: (msg: string) => import("effect/Either").Either<{
30
+ readonly kind: "ARTICLE_EVENT";
31
+ readonly payload: any;
32
+ }, import("@effect/schema/ParseResult").ParseError>;
33
+ fromBuffer: (msg: Buffer) => import("effect/Either").Either<{
34
+ readonly kind: "ARTICLE_EVENT";
35
+ readonly payload: any;
36
+ }, import("@effect/schema/ParseResult").ParseError>;
37
+ fromStringExn: (msg: string) => {
38
+ readonly kind: "ARTICLE_EVENT";
39
+ readonly payload: any;
40
+ };
41
+ fromBufferExn: (msg: Buffer) => {
42
+ readonly kind: "ARTICLE_EVENT";
43
+ readonly payload: any;
44
+ };
45
+ toString: (event: {
46
+ readonly kind: "ARTICLE_EVENT";
47
+ readonly payload: any;
48
+ }) => string;
49
+ toBuffer: (event: {
50
+ readonly kind: "ARTICLE_EVENT";
51
+ readonly payload: any;
52
+ }) => Buffer;
53
+ toStringExn: (event: {
54
+ readonly kind: "ARTICLE_EVENT";
55
+ readonly payload: any;
56
+ }) => string;
57
+ toBufferExn: (event: {
58
+ readonly kind: "ARTICLE_EVENT";
59
+ readonly payload: any;
60
+ }) => Buffer;
61
+ Schema: Schema.Struct<{
62
+ kind: Schema.Literal<["ARTICLE_EVENT"]>;
63
+ payload: Schema.Struct<{
64
+ article: any;
65
+ status: Schema.Literal<["NEW", "UPDATED"]>;
66
+ source: Schema.Literal<["INTERNAL", "EXTERNAL"]>;
67
+ }>;
68
+ }>;
69
+ };
70
+ export default _default;
package/lib/events/ArticleEvent.js ADDED
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const schema_1 = require("@effect/schema");
4
+ const Article_1 = require("../types/Article");
5
+ const makeHelpers_1 = require("../utils/makeHelpers");
6
+ const ArticleEventSchema = schema_1.Schema.Struct({
7
+ kind: schema_1.Schema.Literal('ARTICLE_EVENT'),
8
+ payload: schema_1.Schema.Struct({
9
+ article: Article_1.ArticleSchema,
10
+ status: schema_1.Schema.Literal('NEW', 'UPDATED'),
11
+ source: schema_1.Schema.Literal('INTERNAL', 'EXTERNAL'),
12
+ }),
13
+ });
14
+ const helpers = (0, makeHelpers_1.makeHelpers)(ArticleEventSchema);
15
+ exports.default = Object.assign({ Schema: ArticleEventSchema }, helpers);
package/lib/events/ExternalArticleEvent.d.ts CHANGED
@@ -7,7 +7,7 @@ export declare const ExternalArticleEventSchema: Schema.Struct<{
7
7
  url: typeof Schema.NonEmptyString;
8
8
  site: typeof Schema.NonEmptyString;
9
9
  content: typeof Schema.NonEmptyString;
10
- retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
10
+ retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
11
11
  }>, Schema.SchemaClass<{
12
12
  readonly title?: string | undefined;
13
13
  readonly teaser?: string | undefined;
@@ -424,7 +424,7 @@ declare const _default: {
424
424
  url: typeof Schema.NonEmptyString;
425
425
  site: typeof Schema.NonEmptyString;
426
426
  content: typeof Schema.NonEmptyString;
427
- retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
427
+ retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
428
428
  }>, Schema.SchemaClass<{
429
429
  readonly title?: string | undefined;
430
430
  readonly teaser?: string | undefined;
package/lib/events/InternalArticleEvent.d.ts CHANGED
@@ -2,7 +2,7 @@ import { Schema } from '@effect/schema';
2
2
  export declare const ArticleUnpublishedSchema: Schema.Struct<{
3
3
  status: Schema.Literal<["UNPUBLISHED"]>;
4
4
  id: typeof Schema.NonEmptyString;
5
- unpublishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
5
+ unpublishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
6
6
  }>;
7
7
  export declare const ArticleIngressSchema: Schema.Struct<{
8
8
  source: Schema.Literal<["INTERNAL"]>;
@@ -12,9 +12,9 @@ export declare const ArticleIngressSchema: Schema.Struct<{
12
12
  title: typeof Schema.NonEmptyString;
13
13
  teaser: typeof Schema.NonEmptyString;
14
14
  content: typeof Schema.NonEmptyString;
15
- publishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
16
- updatedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
17
- retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
15
+ publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
16
+ updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
17
+ retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
18
18
  url: typeof Schema.NonEmptyString;
19
19
  site: typeof Schema.NonEmptyString;
20
20
  authors: Schema.Array$<Schema.Struct<{
@@ -32,6 +32,7 @@ export declare const ArticleIngressSchema: Schema.Struct<{
32
32
  extID: typeof Schema.UUID;
33
33
  extSource: typeof Schema.String;
34
34
  }>]>>;
35
+ extId: Schema.optional<typeof Schema.NonEmptyString>;
35
36
  reusePolicy: Schema.optional<Schema.Literal<["strictly_no_reuse", "by_request", "free_to_reuse"]>>;
36
37
  }>>;
37
38
  }>;
@@ -45,9 +46,9 @@ export declare const InternalArticleEventSchema: Schema.Struct<{
45
46
  title: typeof Schema.NonEmptyString;
46
47
  teaser: typeof Schema.NonEmptyString;
47
48
  content: typeof Schema.NonEmptyString;
48
- publishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
49
- updatedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
50
- retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
49
+ publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
50
+ updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
51
+ retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
51
52
  url: typeof Schema.NonEmptyString;
52
53
  site: typeof Schema.NonEmptyString;
53
54
  authors: Schema.Array$<Schema.Struct<{
@@ -65,12 +66,13 @@ export declare const InternalArticleEventSchema: Schema.Struct<{
65
66
  extID: typeof Schema.UUID;
66
67
  extSource: typeof Schema.String;
67
68
  }>]>>;
69
+ extId: Schema.optional<typeof Schema.NonEmptyString>;
68
70
  reusePolicy: Schema.optional<Schema.Literal<["strictly_no_reuse", "by_request", "free_to_reuse"]>>;
69
71
  }>>;
70
72
  }>, Schema.Struct<{
71
73
  status: Schema.Literal<["UNPUBLISHED"]>;
72
74
  id: typeof Schema.NonEmptyString;
73
- unpublishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
75
+ unpublishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
74
76
  }>]>;
75
77
  }>;
76
78
  declare const _default: {
@@ -102,6 +104,7 @@ declare const _default: {
102
104
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
103
105
  readonly id: string;
104
106
  })[];
107
+ readonly extId?: string | undefined;
105
108
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
106
109
  };
107
110
  readonly status: "NEW" | "UPDATED";
@@ -140,6 +143,7 @@ declare const _default: {
140
143
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
141
144
  readonly id: string;
142
145
  })[];
146
+ readonly extId?: string | undefined;
143
147
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
144
148
  };
145
149
  readonly status: "NEW" | "UPDATED";
@@ -178,6 +182,7 @@ declare const _default: {
178
182
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
179
183
  readonly id: string;
180
184
  })[];
185
+ readonly extId?: string | undefined;
181
186
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
182
187
  };
183
188
  readonly status: "NEW" | "UPDATED";
@@ -215,6 +220,7 @@ declare const _default: {
215
220
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
216
221
  readonly id: string;
217
222
  })[];
223
+ readonly extId?: string | undefined;
218
224
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
219
225
  };
220
226
  readonly status: "NEW" | "UPDATED";
@@ -253,6 +259,7 @@ declare const _default: {
253
259
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
254
260
  readonly id: string;
255
261
  })[];
262
+ readonly extId?: string | undefined;
256
263
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
257
264
  };
258
265
  readonly status: "NEW" | "UPDATED";
@@ -290,6 +297,7 @@ declare const _default: {
290
297
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
291
298
  readonly id: string;
292
299
  })[];
300
+ readonly extId?: string | undefined;
293
301
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
294
302
  };
295
303
  readonly status: "NEW" | "UPDATED";
@@ -328,6 +336,7 @@ declare const _default: {
328
336
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
329
337
  readonly id: string;
330
338
  })[];
339
+ readonly extId?: string | undefined;
331
340
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
332
341
  };
333
342
  readonly status: "NEW" | "UPDATED";
@@ -366,6 +375,7 @@ declare const _default: {
366
375
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
367
376
  readonly id: string;
368
377
  })[];
378
+ readonly extId?: string | undefined;
369
379
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
370
380
  };
371
381
  readonly status: "NEW" | "UPDATED";
@@ -404,6 +414,7 @@ declare const _default: {
404
414
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
405
415
  readonly id: string;
406
416
  })[];
417
+ readonly extId?: string | undefined;
407
418
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
408
419
  };
409
420
  readonly status: "NEW" | "UPDATED";
@@ -442,6 +453,7 @@ declare const _default: {
442
453
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
443
454
  readonly id: string;
444
455
  })[];
456
+ readonly extId?: string | undefined;
445
457
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
446
458
  };
447
459
  readonly status: "NEW" | "UPDATED";
@@ -480,6 +492,7 @@ declare const _default: {
480
492
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
481
493
  readonly id: string;
482
494
  })[];
495
+ readonly extId?: string | undefined;
483
496
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
484
497
  };
485
498
  readonly status: "NEW" | "UPDATED";
@@ -518,6 +531,7 @@ declare const _default: {
518
531
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
519
532
  readonly id: string;
520
533
  })[];
534
+ readonly extId?: string | undefined;
521
535
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
522
536
  };
523
537
  readonly status: "NEW" | "UPDATED";
@@ -556,6 +570,7 @@ declare const _default: {
556
570
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
557
571
  readonly id: string;
558
572
  })[];
573
+ readonly extId?: string | undefined;
559
574
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
560
575
  };
561
576
  readonly status: "NEW" | "UPDATED";
@@ -594,6 +609,7 @@ declare const _default: {
594
609
  readonly type: "EXTERNAL_ARTICLE_REFERENCE";
595
610
  readonly id: string;
596
611
  })[];
612
+ readonly extId?: string | undefined;
597
613
  readonly reusePolicy?: "strictly_no_reuse" | "by_request" | "free_to_reuse" | undefined;
598
614
  };
599
615
  readonly status: "NEW" | "UPDATED";
@@ -614,9 +630,9 @@ declare const _default: {
614
630
  title: typeof Schema.NonEmptyString;
615
631
  teaser: typeof Schema.NonEmptyString;
616
632
  content: typeof Schema.NonEmptyString;
617
- publishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
618
- updatedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
619
- retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
633
+ publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
634
+ updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
635
+ retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
620
636
  url: typeof Schema.NonEmptyString;
621
637
  site: typeof Schema.NonEmptyString;
622
638
  authors: Schema.Array$<Schema.Struct<{
@@ -634,12 +650,13 @@ declare const _default: {
634
650
  extID: typeof Schema.UUID;
635
651
  extSource: typeof Schema.String;
636
652
  }>]>>;
653
+ extId: Schema.optional<typeof Schema.NonEmptyString>;
637
654
  reusePolicy: Schema.optional<Schema.Literal<["strictly_no_reuse", "by_request", "free_to_reuse"]>>;
638
655
  }>>;
639
656
  }>, Schema.Struct<{
640
657
  status: Schema.Literal<["UNPUBLISHED"]>;
641
658
  id: typeof Schema.NonEmptyString;
642
- unpublishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
659
+ unpublishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
643
660
  }>]>;
644
661
  }>;
645
662
  };
package/lib/events/InternalArticleEvent.js CHANGED
@@ -6,6 +6,7 @@ const Article_1 = require("../types/Article");
6
6
  const makeHelpers_1 = require("../utils/makeHelpers");
7
7
  const InternalArticleSchema = schema_1.Schema.extend(Article_1.BaseArticleSchema, schema_1.Schema.Struct({
8
8
  tags: schema_1.Schema.Array(schema_1.Schema.Union(Article_1.CategoryTagSchema, Article_1.ExternalArticleReferenceTagSchema, Article_1.DrupalExternalIDTag)),
9
+ extId: schema_1.Schema.optional(schema_1.Schema.NonEmptyString),
9
10
  reusePolicy: schema_1.Schema.optional(schema_1.Schema.Literal('strictly_no_reuse', 'by_request', 'free_to_reuse')),
10
11
  }));
11
12
  exports.ArticleUnpublishedSchema = schema_1.Schema.Struct({
package/lib/types/Article.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { Schema } from '@effect/schema';
2
- export declare const DateTimeSchema: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
2
+ export declare const DateTimeSchema: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
3
3
  export declare const CategoryTagSchema: Schema.Struct<{
4
4
  type: Schema.Literal<["CATEGORY"]>;
5
5
  value: typeof Schema.NonEmptyString;
@@ -21,9 +21,9 @@ export declare const BaseArticleSchema: Schema.Struct<{
21
21
  title: typeof Schema.NonEmptyString;
22
22
  teaser: typeof Schema.NonEmptyString;
23
23
  content: typeof Schema.NonEmptyString;
24
- publishedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
25
- updatedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
26
- retrievedAt: Schema.transformOrFail<typeof Schema.String, typeof Schema.DateTimeUtcFromSelf, never>;
24
+ publishedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
25
+ updatedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
26
+ retrievedAt: Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.DateTimeUtcFromSelf, never>;
27
27
  url: typeof Schema.NonEmptyString;
28
28
  site: typeof Schema.NonEmptyString;
29
29
  authors: Schema.Array$<Schema.Struct<{
package/package.json CHANGED
@@ -1,20 +1,20 @@
1
- {
2
- "name": "@productminds/article-events",
3
- "version": "6.2.0",
4
- "description": "Article events",
5
- "license": "ISC",
6
- "main": "lib/article-events.js",
7
- "typings": "lib/article-events.d.ts",
8
- "directories": {
9
- "lib": "lib"
10
- },
11
- "files": [
12
- "lib"
13
- ],
14
- "scripts": {
15
- "cmd:generate_json_schema": "tsc && node ./lib/cmd/write-json-schema.js",
16
- "build": "tsc",
17
- "build:watch": "tsc --watch",
18
- "build_and_publish": "npm run build && npm publish"
19
- }
20
- }
1
+ {
2
+ "name": "@productminds/article-events",
3
+ "version": "6.2.3",
4
+ "description": "Article events",
5
+ "license": "ISC",
6
+ "main": "lib/article-events.js",
7
+ "typings": "lib/article-events.d.ts",
8
+ "directories": {
9
+ "lib": "lib"
10
+ },
11
+ "files": [
12
+ "lib"
13
+ ],
14
+ "scripts": {
15
+ "cmd:generate_json_schema": "tsc && node ./lib/cmd/write-json-schema.js",
16
+ "build": "tsc",
17
+ "build:watch": "tsc --watch",
18
+ "build_and_publish": "npm run build && npm publish"
19
+ }
20
+ }