@inverted-tech/fragments 0.3.5 → 0.3.6

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 (3) hide show
  1. package/README.PACKAGE.md +47 -54
  2. package/README.md +47 -54
  3. package/package.json +82 -1
package/README.PACKAGE.md CHANGED
@@ -1,54 +1,47 @@
1
- # @inverted-tech/fragments
2
-
3
- Runtime-ready TypeScript artifacts for IT WebServices Fragments.
4
-
5
- What’s included
6
- - Protos: Protobuf-ES message classes and Connect service descriptors.
7
- - Import via subpath: `@inverted-tech/fragments/protos`
8
- - Schemas: Zod validation schemas for domain data messages (requests/responses and service interfaces are excluded).
9
- - Import via subpath: `@inverted-tech/fragments/schemas`
10
- - Dual module outputs (ESM + CJS) and `.d.ts` types.
11
-
12
- Install
13
- ```bash
14
- npm install @inverted-tech/fragments
15
- ```
16
-
17
- Quick start
18
- - Protos (messages + service descriptors)
19
- ```ts
20
- // Namespaced protos
21
- import { Authentication } from '@inverted-tech/fragments/protos/gen/Protos/IT/WebServices/Fragments';
22
-
23
- // Deep import a specific message
24
- import { UserRecord } from '@inverted-tech/fragments/protos/gen/Protos/IT/WebServices/Fragments/Authentication/UserRecord_pb';
25
- ```
26
-
27
- - Schemas (runtime validation with Zod)
28
- ```ts
29
- // Namespaced schemas
30
- import { IT as Schemas } from '@inverted-tech/fragments/schemas/IT';
31
- const UserRecordSchema = Schemas.WebServices.Fragments.Authentication.UserRecordSchema;
32
-
33
- // Or deep import a specific schema
34
- import { UserRecordSchema } from '@inverted-tech/fragments/schemas/IT/WebServices/Fragments/Authentication/UserRecord';
35
-
36
- // Infer TS types from schemas
37
- import { z } from 'zod';
38
- type UserRecordInput = z.infer<typeof UserRecordSchema>;
39
- ```
40
-
41
- Notes
42
- - Zod schemas focus on domain data messages (e.g., `*Record`, `*Settings`).
43
- - Request/Response and service-interface-only types are intentionally omitted.
44
- - Timestamps map to `Date`. Duration maps to `{ seconds?: bigint; nanos?: number }`.
45
-
46
- Support matrix
47
- - Node.js ≥ 18
48
- - Modern browsers (ES2020)
49
-
50
- Changelog
51
- - This package uses Changesets; see release notes on the npm page.
52
-
53
- License
54
- - See `LICENSE` in the package.
1
+ # @inverted-tech/fragments
2
+
3
+ TypeScript types and ESM runtime for IT WebServices Protobufs.
4
+
5
+ This package is ESM-only and ships `.d.ts` declaration files plus generated JS under `dist/esm/`.
6
+
7
+ Install
8
+ ```bash
9
+ npm install @inverted-tech/fragments
10
+ ```
11
+
12
+ ## Imports
13
+ We expose convenient subpaths for each module and file-level entries. You don’t need to append `/index`.
14
+
15
+ Examples
16
+ ```ts
17
+ // Settings models
18
+ import type { CMSPublicRecord, ChannelRecord, CategoryRecord } from '@inverted-tech/fragments/Settings';
19
+ // or with a trailing slash
20
+ import type { CMSPublicMenuRecord } from '@inverted-tech/fragments/Settings/';
21
+
22
+ // Specific files
23
+ import type { UserRecord } from '@inverted-tech/fragments/Authentication/UserRecord';
24
+ import { UserInterfaceClient } from '@inverted-tech/fragments/Authentication/UserInterface_connect';
25
+
26
+ // Protos bundle
27
+ import * as Protos from '@inverted-tech/fragments/protos';
28
+ // or file-level
29
+ import '@inverted-tech/fragments/protos/Authentication/UserInterface_connect';
30
+ ```
31
+
32
+ Available namespaces: Authentication, Authorization, Comment, Content, CreatorDashboard, Generic, Notification, Page, Settings.
33
+
34
+ ## Notes
35
+ - ESM-only; no CommonJS entry points.
36
+ - Built from protobuf sources using Buf and TypeScript generators.
37
+
38
+ ## Support
39
+ - Node.js 18+
40
+ - Modern browsers (ES2020)
41
+
42
+ ## Changelog
43
+ This package uses Changesets; see release notes on npm.
44
+
45
+ ## License
46
+ MIT — see `LICENSE`.
47
+
package/README.md CHANGED
@@ -1,54 +1,47 @@
1
- # @inverted-tech/fragments
2
-
3
- Runtime-ready TypeScript artifacts for IT WebServices Fragments.
4
-
5
- What’s included
6
- - Protos: Protobuf-ES message classes and Connect service descriptors.
7
- - Import via subpath: `@inverted-tech/fragments/protos`
8
- - Schemas: Zod validation schemas for domain data messages (requests/responses and service interfaces are excluded).
9
- - Import via subpath: `@inverted-tech/fragments/schemas`
10
- - Dual module outputs (ESM + CJS) and `.d.ts` types.
11
-
12
- Install
13
- ```bash
14
- npm install @inverted-tech/fragments
15
- ```
16
-
17
- Quick start
18
- - Protos (messages + service descriptors)
19
- ```ts
20
- // Namespaced protos
21
- import { Authentication } from '@inverted-tech/fragments/protos/gen/Protos/IT/WebServices/Fragments';
22
-
23
- // Deep import a specific message
24
- import { UserRecord } from '@inverted-tech/fragments/protos/gen/Protos/IT/WebServices/Fragments/Authentication/UserRecord_pb';
25
- ```
26
-
27
- - Schemas (runtime validation with Zod)
28
- ```ts
29
- // Namespaced schemas
30
- import { IT as Schemas } from '@inverted-tech/fragments/schemas/IT';
31
- const UserRecordSchema = Schemas.WebServices.Fragments.Authentication.UserRecordSchema;
32
-
33
- // Or deep import a specific schema
34
- import { UserRecordSchema } from '@inverted-tech/fragments/schemas/IT/WebServices/Fragments/Authentication/UserRecord';
35
-
36
- // Infer TS types from schemas
37
- import { z } from 'zod';
38
- type UserRecordInput = z.infer<typeof UserRecordSchema>;
39
- ```
40
-
41
- Notes
42
- - Zod schemas focus on domain data messages (e.g., `*Record`, `*Settings`).
43
- - Request/Response and service-interface-only types are intentionally omitted.
44
- - Timestamps map to `Date`. Duration maps to `{ seconds?: bigint; nanos?: number }`.
45
-
46
- Support matrix
47
- - Node.js ≥ 18
48
- - Modern browsers (ES2020)
49
-
50
- Changelog
51
- - This package uses Changesets; see release notes on the npm page.
52
-
53
- License
54
- - See `LICENSE` in the package.
1
+ # @inverted-tech/fragments
2
+
3
+ TypeScript types and ESM runtime for IT WebServices Protobufs.
4
+
5
+ This package is ESM-only and ships `.d.ts` declaration files plus generated JS under `dist/esm/`.
6
+
7
+ Install
8
+ ```bash
9
+ npm install @inverted-tech/fragments
10
+ ```
11
+
12
+ ## Imports
13
+ We expose convenient subpaths for each module and file-level entries. You don’t need to append `/index`.
14
+
15
+ Examples
16
+ ```ts
17
+ // Settings models
18
+ import type { CMSPublicRecord, ChannelRecord, CategoryRecord } from '@inverted-tech/fragments/Settings';
19
+ // or with a trailing slash
20
+ import type { CMSPublicMenuRecord } from '@inverted-tech/fragments/Settings/';
21
+
22
+ // Specific files
23
+ import type { UserRecord } from '@inverted-tech/fragments/Authentication/UserRecord';
24
+ import { UserInterfaceClient } from '@inverted-tech/fragments/Authentication/UserInterface_connect';
25
+
26
+ // Protos bundle
27
+ import * as Protos from '@inverted-tech/fragments/protos';
28
+ // or file-level
29
+ import '@inverted-tech/fragments/protos/Authentication/UserInterface_connect';
30
+ ```
31
+
32
+ Available namespaces: Authentication, Authorization, Comment, Content, CreatorDashboard, Generic, Notification, Page, Settings.
33
+
34
+ ## Notes
35
+ - ESM-only; no CommonJS entry points.
36
+ - Built from protobuf sources using Buf and TypeScript generators.
37
+
38
+ ## Support
39
+ - Node.js 18+
40
+ - Modern browsers (ES2020)
41
+
42
+ ## Changelog
43
+ This package uses Changesets; see release notes on npm.
44
+
45
+ ## License
46
+ MIT — see `LICENSE`.
47
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inverted-tech/fragments",
3
- "version": "0.3.5",
3
+ "version": "0.3.6",
4
4
  "description": "Types and JS runtime for Inverted protocol buffers (Fragments)",
5
5
  "types": "dist/protos/index.d.ts",
6
6
  "module": "dist/esm/index.js",
@@ -23,38 +23,119 @@
23
23
  "types": "./dist/protos/*.d.ts",
24
24
  "import": "./dist/esm/protos/*.js"
25
25
  },
26
+ "./Authorization": {
27
+ "types": "./dist/protos/Authorization/index.d.ts",
28
+ "import": "./dist/esm/Authorization/index.js",
29
+ "default": "./dist/esm/Authorization/index.js"
30
+ },
31
+ "./Authorization/": {
32
+ "types": "./dist/protos/Authorization/",
33
+ "import": "./dist/esm/Authorization/"
34
+ },
26
35
  "./Authorization/*": {
27
36
  "types": "./dist/protos/Authorization/*.d.ts",
28
37
  "import": "./dist/esm/Authorization/*.js"
29
38
  },
39
+ "./Authentication": {
40
+ "types": "./dist/protos/Authentication/index.d.ts",
41
+ "import": "./dist/esm/Authentication/index.js",
42
+ "default": "./dist/esm/Authentication/index.js"
43
+ },
44
+ "./Authentication/": {
45
+ "types": "./dist/protos/Authentication/",
46
+ "import": "./dist/esm/Authentication/"
47
+ },
30
48
  "./Authentication/*": {
31
49
  "types": "./dist/protos/Authentication/*.d.ts",
32
50
  "import": "./dist/esm/Authentication/*.js"
33
51
  },
52
+ "./Comment": {
53
+ "types": "./dist/protos/Comment/index.d.ts",
54
+ "import": "./dist/esm/Comment/index.js",
55
+ "default": "./dist/esm/Comment/index.js"
56
+ },
57
+ "./Comment/": {
58
+ "types": "./dist/protos/Comment/",
59
+ "import": "./dist/esm/Comment/"
60
+ },
34
61
  "./Comment/*": {
35
62
  "types": "./dist/protos/Comment/*.d.ts",
36
63
  "import": "./dist/esm/Comment/*.js"
37
64
  },
65
+ "./Content": {
66
+ "types": "./dist/protos/Content/index.d.ts",
67
+ "import": "./dist/esm/Content/index.js",
68
+ "default": "./dist/esm/Content/index.js"
69
+ },
70
+ "./Content/": {
71
+ "types": "./dist/protos/Content/",
72
+ "import": "./dist/esm/Content/"
73
+ },
38
74
  "./Content/*": {
39
75
  "types": "./dist/protos/Content/*.d.ts",
40
76
  "import": "./dist/esm/Content/*.js"
41
77
  },
78
+ "./CreatorDashboard": {
79
+ "types": "./dist/protos/CreatorDashboard/index.d.ts",
80
+ "import": "./dist/esm/CreatorDashboard/index.js",
81
+ "default": "./dist/esm/CreatorDashboard/index.js"
82
+ },
83
+ "./CreatorDashboard/": {
84
+ "types": "./dist/protos/CreatorDashboard/",
85
+ "import": "./dist/esm/CreatorDashboard/"
86
+ },
42
87
  "./CreatorDashboard/*": {
43
88
  "types": "./dist/protos/CreatorDashboard/*.d.ts",
44
89
  "import": "./dist/esm/CreatorDashboard/*.js"
45
90
  },
91
+ "./Generic": {
92
+ "types": "./dist/protos/Generic/index.d.ts",
93
+ "import": "./dist/esm/Generic/index.js",
94
+ "default": "./dist/esm/Generic/index.js"
95
+ },
96
+ "./Generic/": {
97
+ "types": "./dist/protos/Generic/",
98
+ "import": "./dist/esm/Generic/"
99
+ },
46
100
  "./Generic/*": {
47
101
  "types": "./dist/protos/Generic/*.d.ts",
48
102
  "import": "./dist/esm/Generic/*.js"
49
103
  },
104
+ "./Notification": {
105
+ "types": "./dist/protos/Notification/index.d.ts",
106
+ "import": "./dist/esm/Notification/index.js",
107
+ "default": "./dist/esm/Notification/index.js"
108
+ },
109
+ "./Notification/": {
110
+ "types": "./dist/protos/Notification/",
111
+ "import": "./dist/esm/Notification/"
112
+ },
50
113
  "./Notification/*": {
51
114
  "types": "./dist/protos/Notification/*.d.ts",
52
115
  "import": "./dist/esm/Notification/*.js"
53
116
  },
117
+ "./Page": {
118
+ "types": "./dist/protos/Page/index.d.ts",
119
+ "import": "./dist/esm/Page/index.js",
120
+ "default": "./dist/esm/Page/index.js"
121
+ },
122
+ "./Page/": {
123
+ "types": "./dist/protos/Page/",
124
+ "import": "./dist/esm/Page/"
125
+ },
54
126
  "./Page/*": {
55
127
  "types": "./dist/protos/Page/*.d.ts",
56
128
  "import": "./dist/esm/Page/*.js"
57
129
  },
130
+ "./Settings": {
131
+ "types": "./dist/protos/Settings/index.d.ts",
132
+ "import": "./dist/esm/Settings/index.js",
133
+ "default": "./dist/esm/Settings/index.js"
134
+ },
135
+ "./Settings/": {
136
+ "types": "./dist/protos/Settings/",
137
+ "import": "./dist/esm/Settings/"
138
+ },
58
139
  "./Settings/*": {
59
140
  "types": "./dist/protos/Settings/*.d.ts",
60
141
  "import": "./dist/esm/Settings/*.js"