@onereach/idw-contracts 0.1.1

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 (116) hide show
  1. package/README.md +43 -0
  2. package/dist/cjs/api.js +3 -0
  3. package/dist/cjs/api.js.map +1 -0
  4. package/dist/cjs/chat/index.js +21 -0
  5. package/dist/cjs/chat/index.js.map +1 -0
  6. package/dist/cjs/chat/message.js +10 -0
  7. package/dist/cjs/chat/message.js.map +1 -0
  8. package/dist/cjs/chat/socket.js +3 -0
  9. package/dist/cjs/chat/socket.js.map +1 -0
  10. package/dist/cjs/chat/sources.js +3 -0
  11. package/dist/cjs/chat/sources.js.map +1 -0
  12. package/dist/cjs/chat/stream-events.js +131 -0
  13. package/dist/cjs/chat/stream-events.js.map +1 -0
  14. package/dist/cjs/common.js +14 -0
  15. package/dist/cjs/common.js.map +1 -0
  16. package/dist/cjs/datasources.js +3 -0
  17. package/dist/cjs/datasources.js.map +1 -0
  18. package/dist/cjs/idw-summary.js +14 -0
  19. package/dist/cjs/idw-summary.js.map +1 -0
  20. package/dist/cjs/idw.js +3 -0
  21. package/dist/cjs/idw.js.map +1 -0
  22. package/dist/cjs/index.js +29 -0
  23. package/dist/cjs/index.js.map +1 -0
  24. package/dist/cjs/knowledge/filters.js +12 -0
  25. package/dist/cjs/knowledge/filters.js.map +1 -0
  26. package/dist/cjs/knowledge/index.js +30 -0
  27. package/dist/cjs/knowledge/index.js.map +1 -0
  28. package/dist/cjs/knowledge/knowledges.js +17 -0
  29. package/dist/cjs/knowledge/knowledges.js.map +1 -0
  30. package/dist/cjs/models.js +3 -0
  31. package/dist/cjs/models.js.map +1 -0
  32. package/dist/cjs/onboarding.js +11 -0
  33. package/dist/cjs/onboarding.js.map +1 -0
  34. package/dist/cjs/skill.js +18 -0
  35. package/dist/cjs/skill.js.map +1 -0
  36. package/dist/cjs/user-selections.js +3 -0
  37. package/dist/cjs/user-selections.js.map +1 -0
  38. package/dist/cjs/users.js +11 -0
  39. package/dist/cjs/users.js.map +1 -0
  40. package/dist/esm/api.js +2 -0
  41. package/dist/esm/api.js.map +1 -0
  42. package/dist/esm/chat/index.js +5 -0
  43. package/dist/esm/chat/index.js.map +1 -0
  44. package/dist/esm/chat/message.js +7 -0
  45. package/dist/esm/chat/message.js.map +1 -0
  46. package/dist/esm/chat/socket.js +2 -0
  47. package/dist/esm/chat/socket.js.map +1 -0
  48. package/dist/esm/chat/sources.js +2 -0
  49. package/dist/esm/chat/sources.js.map +1 -0
  50. package/dist/esm/chat/stream-events.js +123 -0
  51. package/dist/esm/chat/stream-events.js.map +1 -0
  52. package/dist/esm/common.js +11 -0
  53. package/dist/esm/common.js.map +1 -0
  54. package/dist/esm/datasources.js +2 -0
  55. package/dist/esm/datasources.js.map +1 -0
  56. package/dist/esm/idw-summary.js +11 -0
  57. package/dist/esm/idw-summary.js.map +1 -0
  58. package/dist/esm/idw.js +2 -0
  59. package/dist/esm/idw.js.map +1 -0
  60. package/dist/esm/index.js +13 -0
  61. package/dist/esm/index.js.map +1 -0
  62. package/dist/esm/knowledge/filters.js +9 -0
  63. package/dist/esm/knowledge/filters.js.map +1 -0
  64. package/dist/esm/knowledge/index.js +13 -0
  65. package/dist/esm/knowledge/index.js.map +1 -0
  66. package/dist/esm/knowledge/knowledges.js +14 -0
  67. package/dist/esm/knowledge/knowledges.js.map +1 -0
  68. package/dist/esm/models.js +2 -0
  69. package/dist/esm/models.js.map +1 -0
  70. package/dist/esm/onboarding.js +8 -0
  71. package/dist/esm/onboarding.js.map +1 -0
  72. package/dist/esm/skill.js +14 -0
  73. package/dist/esm/skill.js.map +1 -0
  74. package/dist/esm/user-selections.js +2 -0
  75. package/dist/esm/user-selections.js.map +1 -0
  76. package/dist/esm/users.js +8 -0
  77. package/dist/esm/users.js.map +1 -0
  78. package/dist/types/api.d.ts +36 -0
  79. package/dist/types/api.d.ts.map +1 -0
  80. package/dist/types/chat/index.d.ts +50 -0
  81. package/dist/types/chat/index.d.ts.map +1 -0
  82. package/dist/types/chat/message.d.ts +98 -0
  83. package/dist/types/chat/message.d.ts.map +1 -0
  84. package/dist/types/chat/socket.d.ts +13 -0
  85. package/dist/types/chat/socket.d.ts.map +1 -0
  86. package/dist/types/chat/sources.d.ts +48 -0
  87. package/dist/types/chat/sources.d.ts.map +1 -0
  88. package/dist/types/chat/stream-events.d.ts +158 -0
  89. package/dist/types/chat/stream-events.d.ts.map +1 -0
  90. package/dist/types/common.d.ts +34 -0
  91. package/dist/types/common.d.ts.map +1 -0
  92. package/dist/types/datasources.d.ts +52 -0
  93. package/dist/types/datasources.d.ts.map +1 -0
  94. package/dist/types/idw-summary.d.ts +20 -0
  95. package/dist/types/idw-summary.d.ts.map +1 -0
  96. package/dist/types/idw.d.ts +40 -0
  97. package/dist/types/idw.d.ts.map +1 -0
  98. package/dist/types/index.d.ts +13 -0
  99. package/dist/types/index.d.ts.map +1 -0
  100. package/dist/types/knowledge/filters.d.ts +26 -0
  101. package/dist/types/knowledge/filters.d.ts.map +1 -0
  102. package/dist/types/knowledge/index.d.ts +32 -0
  103. package/dist/types/knowledge/index.d.ts.map +1 -0
  104. package/dist/types/knowledge/knowledges.d.ts +71 -0
  105. package/dist/types/knowledge/knowledges.d.ts.map +1 -0
  106. package/dist/types/models.d.ts +19 -0
  107. package/dist/types/models.d.ts.map +1 -0
  108. package/dist/types/onboarding.d.ts +98 -0
  109. package/dist/types/onboarding.d.ts.map +1 -0
  110. package/dist/types/skill.d.ts +85 -0
  111. package/dist/types/skill.d.ts.map +1 -0
  112. package/dist/types/user-selections.d.ts +5 -0
  113. package/dist/types/user-selections.d.ts.map +1 -0
  114. package/dist/types/users.d.ts +14 -0
  115. package/dist/types/users.d.ts.map +1 -0
  116. package/package.json +41 -0
@@ -0,0 +1,85 @@
1
+ export type Skill = {
2
+ id: string;
3
+ name: string;
4
+ description: string;
5
+ slug: string;
6
+ url: string;
7
+ created_by: string | null;
8
+ created_at: string;
9
+ image: string;
10
+ forRoles?: string[];
11
+ forUsers?: string[];
12
+ forGroups?: string[];
13
+ installed?: unknown;
14
+ domain: string;
15
+ domains: Array<{
16
+ id: string;
17
+ name: string;
18
+ image: string;
19
+ created_at: number;
20
+ abbreviation: string;
21
+ }>;
22
+ meta: {
23
+ chat?: {
24
+ id?: string;
25
+ url?: string;
26
+ web?: boolean;
27
+ };
28
+ skill: {
29
+ disabled?: boolean;
30
+ editable?: boolean;
31
+ isSystem?: boolean;
32
+ inputSchema?: string;
33
+ outputSchema?: string;
34
+ };
35
+ docUrl?: string;
36
+ dependencies: Record<never, never>;
37
+ isLibrary?: boolean;
38
+ sourceId?: string;
39
+ };
40
+ };
41
+ export type CreateSkillParams = {
42
+ skill: {
43
+ name: string;
44
+ description: string;
45
+ created_by: string;
46
+ url: string;
47
+ forRoles?: string[];
48
+ forUsers?: string[];
49
+ forGroups?: string[];
50
+ meta: {
51
+ docUrl?: string;
52
+ chat?: {
53
+ id?: string;
54
+ url: string;
55
+ web?: boolean;
56
+ };
57
+ skill?: {
58
+ inputSchema?: string;
59
+ outputSchema?: string;
60
+ };
61
+ };
62
+ };
63
+ domain: {
64
+ name: string;
65
+ };
66
+ };
67
+ export type EditSkillParams = CreateSkillParams & {
68
+ skill: CreateSkillParams['skill'] & {
69
+ id: string;
70
+ };
71
+ };
72
+ export declare class SkillError extends Error {
73
+ skill: Skill;
74
+ params: object;
75
+ constructor(message: string, { skill, params }: {
76
+ skill: Skill;
77
+ params: object;
78
+ }, options?: {});
79
+ }
80
+ export declare enum CardSize {
81
+ XS = "xs",
82
+ S = "s",
83
+ L = "l"
84
+ }
85
+ //# sourceMappingURL=skill.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"skill.d.ts","sourceRoot":"","sources":["../../src/skill.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,KAAK,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;IACH,IAAI,EAAE;QACJ,IAAI,CAAC,EAAE;YACL,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,GAAG,CAAC,EAAE,OAAO,CAAC;SACf,CAAC;QACF,KAAK,EAAE;YACL,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB,CAAC;QACF,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACnC,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,IAAI,EAAE;YACJ,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,IAAI,CAAC,EAAE;gBACL,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,GAAG,EAAE,MAAM,CAAC;gBACZ,GAAG,CAAC,EAAE,OAAO,CAAC;aACf,CAAC;YACF,KAAK,CAAC,EAAE;gBACN,WAAW,CAAC,EAAE,MAAM,CAAC;gBACrB,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB,CAAC;SACH,CAAC;KACH,CAAC;IACF,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG;IAChD,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,GAAG;QAClC,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC;CACH,CAAC;AAEF,qBAAa,UAAW,SAAQ,KAAK;IACnC,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;gBAGb,OAAO,EAAE,MAAM,EACf,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EACnD,OAAO,KAAK;CAMf;AAED,oBAAY,QAAQ;IAClB,EAAE,OAAO;IACT,CAAC,MAAM;IACP,CAAC,MAAM;CACR"}
@@ -0,0 +1,5 @@
1
+ export type UserSelections = {
2
+ isMultiModel: boolean;
3
+ models: string[];
4
+ };
5
+ //# sourceMappingURL=user-selections.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"user-selections.d.ts","sourceRoot":"","sources":["../../src/user-selections.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}
@@ -0,0 +1,14 @@
1
+ export declare const enum EUserRoles {
2
+ GUEST = "anonymous",
3
+ USER = "user",
4
+ ADMIN = "admin",
5
+ SUPER_ADMIN = "super_admin"
6
+ }
7
+ export type UserInfo = {
8
+ id: string;
9
+ label: string;
10
+ role: EUserRoles;
11
+ firstName: string;
12
+ lastName: string;
13
+ };
14
+ //# sourceMappingURL=users.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/users.ts"],"names":[],"mappings":"AAAA,0BAAkB,UAAU;IAC1B,KAAK,cAAc;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "@onereach/idw-contracts",
3
+ "version": "0.1.1",
4
+ "description": "Shared IDW contracts, schemas and types (isomorphic, consumed by idw-api and idw-ui).",
5
+ "license": "Apache-2.0",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/esm/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "files": [
10
+ "dist"
11
+ ],
12
+ "scripts": {
13
+ "build": "pnpm clean && concurrently 'pnpm:build:*(!watch)'",
14
+ "build:cjs": "tsc --project tsconfig.json",
15
+ "build:esm": "tsc --project tsconfig.esm.json",
16
+ "build:types": "tsc --project tsconfig.types.json",
17
+ "build:watch": "concurrently 'pnpm:build:watch:*'",
18
+ "build:watch:cjs": "pnpm build:cjs -w",
19
+ "build:watch:esm": "pnpm build:esm -w",
20
+ "build:watch:types": "pnpm build:types -w",
21
+ "clean": "rm -rf ./dist",
22
+ "dev": "pnpm build:watch:esm",
23
+ "test": "vitest --run",
24
+ "test:watch": "vitest --watch"
25
+ },
26
+ "dependencies": {
27
+ "zod": "^3.24.4"
28
+ },
29
+ "devDependencies": {
30
+ "axios": "^1.12.2",
31
+ "concurrently": "9.2.0",
32
+ "typescript": "5.6.2"
33
+ },
34
+ "peerDependencies": {
35
+ "axios": ">=1"
36
+ },
37
+ "publishConfig": {
38
+ "access": "public"
39
+ },
40
+ "gitHead": "38fbf320361316c3700582c9ab3370a0f199d6cb"
41
+ }