@getzep/zep-cloud 1.0.4 → 1.0.5

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 (105) hide show
  1. package/api/resources/document/client/Client.js +13 -13
  2. package/api/resources/memory/client/Client.d.ts +18 -0
  3. package/api/resources/memory/client/Client.js +104 -17
  4. package/api/resources/memory/client/requests/ExtractDataRequest.d.ts +23 -0
  5. package/api/resources/memory/client/requests/ExtractDataRequest.js +5 -0
  6. package/api/resources/memory/client/requests/index.d.ts +1 -0
  7. package/api/resources/user/client/Client.js +6 -6
  8. package/api/types/Fact.d.ts +8 -0
  9. package/api/types/Fact.js +5 -0
  10. package/api/types/SearchScope.d.ts +2 -1
  11. package/api/types/SearchScope.js +1 -0
  12. package/api/types/Session.d.ts +1 -0
  13. package/api/types/SessionSearchResult.d.ts +1 -0
  14. package/api/types/index.d.ts +1 -0
  15. package/api/types/index.js +1 -0
  16. package/dist/api/resources/document/client/Client.js +13 -13
  17. package/dist/api/resources/memory/client/Client.d.ts +18 -0
  18. package/dist/api/resources/memory/client/Client.js +104 -17
  19. package/dist/api/resources/memory/client/requests/ExtractDataRequest.d.ts +23 -0
  20. package/dist/api/resources/memory/client/requests/ExtractDataRequest.js +5 -0
  21. package/dist/api/resources/memory/client/requests/index.d.ts +1 -0
  22. package/dist/api/resources/user/client/Client.js +6 -6
  23. package/dist/api/types/Fact.d.ts +8 -0
  24. package/dist/api/types/Fact.js +5 -0
  25. package/dist/api/types/SearchScope.d.ts +2 -1
  26. package/dist/api/types/SearchScope.js +1 -0
  27. package/dist/api/types/Session.d.ts +1 -0
  28. package/dist/api/types/SessionSearchResult.d.ts +1 -0
  29. package/dist/api/types/index.d.ts +1 -0
  30. package/dist/api/types/index.js +1 -0
  31. package/dist/extractor/base.d.ts +22 -0
  32. package/dist/extractor/base.js +20 -0
  33. package/dist/extractor/date.d.ts +24 -0
  34. package/dist/extractor/date.js +29 -0
  35. package/dist/extractor/index.d.ts +281 -0
  36. package/dist/extractor/index.js +31 -0
  37. package/dist/extractor/number.d.ts +27 -0
  38. package/dist/extractor/number.js +37 -0
  39. package/dist/extractor/regex.d.ts +30 -0
  40. package/dist/extractor/regex.js +29 -0
  41. package/dist/extractor/text.d.ts +29 -0
  42. package/dist/extractor/text.js +43 -0
  43. package/dist/index.d.ts +1 -0
  44. package/dist/index.js +3 -1
  45. package/dist/serialization/resources/memory/client/extractData.d.ts +9 -0
  46. package/dist/serialization/resources/memory/client/extractData.js +31 -0
  47. package/dist/serialization/resources/memory/client/index.d.ts +1 -0
  48. package/dist/serialization/resources/memory/client/index.js +2 -1
  49. package/dist/serialization/resources/memory/client/requests/ExtractDataRequest.d.ts +15 -0
  50. package/dist/serialization/resources/memory/client/requests/ExtractDataRequest.js +36 -0
  51. package/dist/serialization/resources/memory/client/requests/index.d.ts +1 -0
  52. package/dist/serialization/resources/memory/client/requests/index.js +3 -1
  53. package/dist/serialization/types/Fact.d.ts +14 -0
  54. package/dist/serialization/types/Fact.js +35 -0
  55. package/dist/serialization/types/SearchScope.d.ts +1 -1
  56. package/dist/serialization/types/SearchScope.js +1 -1
  57. package/dist/serialization/types/Session.d.ts +1 -0
  58. package/dist/serialization/types/Session.js +1 -0
  59. package/dist/serialization/types/SessionSearchResult.d.ts +2 -0
  60. package/dist/serialization/types/SessionSearchResult.js +2 -0
  61. package/dist/serialization/types/index.d.ts +1 -0
  62. package/dist/serialization/types/index.js +1 -0
  63. package/dist/wrapper/index.d.ts +2 -0
  64. package/dist/wrapper/index.js +4 -0
  65. package/dist/wrapper/memory.d.ts +35 -0
  66. package/dist/wrapper/memory.js +59 -0
  67. package/examples/memory/memory_example.ts +27 -8
  68. package/examples/memory/structured_data_extraction_example.ts +34 -0
  69. package/extractor/base.d.ts +22 -0
  70. package/extractor/base.js +20 -0
  71. package/extractor/date.d.ts +24 -0
  72. package/extractor/date.js +29 -0
  73. package/extractor/index.d.ts +281 -0
  74. package/extractor/index.js +31 -0
  75. package/extractor/number.d.ts +27 -0
  76. package/extractor/number.js +37 -0
  77. package/extractor/regex.d.ts +30 -0
  78. package/extractor/regex.js +29 -0
  79. package/extractor/text.d.ts +29 -0
  80. package/extractor/text.js +43 -0
  81. package/index.d.ts +1 -0
  82. package/index.js +3 -1
  83. package/package.json +11 -5
  84. package/serialization/resources/memory/client/extractData.d.ts +9 -0
  85. package/serialization/resources/memory/client/extractData.js +31 -0
  86. package/serialization/resources/memory/client/index.d.ts +1 -0
  87. package/serialization/resources/memory/client/index.js +2 -1
  88. package/serialization/resources/memory/client/requests/ExtractDataRequest.d.ts +15 -0
  89. package/serialization/resources/memory/client/requests/ExtractDataRequest.js +36 -0
  90. package/serialization/resources/memory/client/requests/index.d.ts +1 -0
  91. package/serialization/resources/memory/client/requests/index.js +3 -1
  92. package/serialization/types/Fact.d.ts +14 -0
  93. package/serialization/types/Fact.js +35 -0
  94. package/serialization/types/SearchScope.d.ts +1 -1
  95. package/serialization/types/SearchScope.js +1 -1
  96. package/serialization/types/Session.d.ts +1 -0
  97. package/serialization/types/Session.js +1 -0
  98. package/serialization/types/SessionSearchResult.d.ts +2 -0
  99. package/serialization/types/SessionSearchResult.js +2 -0
  100. package/serialization/types/index.d.ts +1 -0
  101. package/serialization/types/index.js +1 -0
  102. package/wrapper/index.d.ts +2 -0
  103. package/wrapper/index.js +4 -0
  104. package/wrapper/memory.d.ts +35 -0
  105. package/wrapper/memory.js +59 -0
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BaseSchema = exports.ZepDataType = void 0;
4
+ const zod_1 = require("zod");
5
+ var ZepDataType;
6
+ (function (ZepDataType) {
7
+ ZepDataType["ZepText"] = "ZepText";
8
+ ZepDataType["ZepZipCode"] = "ZepZipCode";
9
+ ZepDataType["ZepDate"] = "ZepDate";
10
+ ZepDataType["ZepDateTime"] = "ZepDateTime";
11
+ ZepDataType["ZepEmail"] = "ZepEmail";
12
+ ZepDataType["ZepPhoneNumber"] = "ZepPhoneNumber";
13
+ ZepDataType["ZepFloat"] = "ZepFloat";
14
+ ZepDataType["ZepNumber"] = "ZepNumber";
15
+ ZepDataType["ZepRegex"] = "ZepRegex";
16
+ })(ZepDataType = exports.ZepDataType || (exports.ZepDataType = {}));
17
+ exports.BaseSchema = zod_1.z.object({
18
+ zep_type: zod_1.z.nativeEnum(ZepDataType),
19
+ description: zod_1.z.string(),
20
+ });
@@ -0,0 +1,24 @@
1
+ import { z } from "zod";
2
+ import { ZepDataType } from "./base";
3
+ import { HasOptionalValue } from "./index";
4
+ export declare const ZepDateSchema: z.ZodObject<z.objectUtil.extendShape<{
5
+ zep_type: z.ZodNativeEnum<typeof ZepDataType>;
6
+ description: z.ZodString;
7
+ }, {
8
+ zep_type: z.ZodUnion<[z.ZodLiteral<ZepDataType.ZepDate>, z.ZodLiteral<ZepDataType.ZepDateTime>]>;
9
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, Date, string | Date>>;
10
+ }>, "strip", z.ZodTypeAny, {
11
+ description: string;
12
+ zep_type: ZepDataType.ZepDate | ZepDataType.ZepDateTime;
13
+ value?: Date | undefined;
14
+ }, {
15
+ description: string;
16
+ zep_type: ZepDataType.ZepDate | ZepDataType.ZepDateTime;
17
+ value?: string | Date | undefined;
18
+ }>;
19
+ export interface ZepDateField extends HasOptionalValue<Date> {
20
+ zep_type: ZepDataType.ZepDate | ZepDataType.ZepDateTime;
21
+ description: string;
22
+ }
23
+ export declare const zepDateField: (description: string) => ZepDateField;
24
+ export declare const zepDateTimeField: (description: string) => ZepDateField;
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.zepDateTimeField = exports.zepDateField = exports.ZepDateSchema = void 0;
4
+ const zod_1 = require("zod");
5
+ const base_1 = require("./base");
6
+ const stringToDateTransformer = zod_1.z.union([zod_1.z.string(), zod_1.z.date()]).transform((value, ctx) => {
7
+ if (typeof value === "string") {
8
+ return new Date(value);
9
+ }
10
+ return value;
11
+ });
12
+ exports.ZepDateSchema = base_1.BaseSchema.extend({
13
+ zep_type: zod_1.z.union([zod_1.z.literal(base_1.ZepDataType.ZepDate), zod_1.z.literal(base_1.ZepDataType.ZepDateTime)]),
14
+ value: stringToDateTransformer.optional(),
15
+ });
16
+ const zepDateField = (description) => {
17
+ return exports.ZepDateSchema.parse({
18
+ zep_type: base_1.ZepDataType.ZepDate,
19
+ description,
20
+ });
21
+ };
22
+ exports.zepDateField = zepDateField;
23
+ const zepDateTimeField = (description) => {
24
+ return exports.ZepDateSchema.parse({
25
+ zep_type: base_1.ZepDataType.ZepDateTime,
26
+ description,
27
+ });
28
+ };
29
+ exports.zepDateTimeField = zepDateTimeField;
@@ -0,0 +1,281 @@
1
+ import { z } from "zod";
2
+ import { ZepDateField } from "./date";
3
+ import { ZepNumberField } from "./number";
4
+ import { ZepTextField } from "./text";
5
+ import { ZepRegexField } from "./regex";
6
+ export declare const DataExtractorFields: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
7
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
8
+ description: z.ZodString;
9
+ }, {
10
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepNumber>, z.ZodLiteral<import("./base").ZepDataType.ZepFloat>]>;
11
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
12
+ default: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
13
+ }>, "strip", z.ZodTypeAny, {
14
+ description: string;
15
+ zep_type: import("./base").ZepDataType.ZepFloat | import("./base").ZepDataType.ZepNumber;
16
+ value?: number | undefined;
17
+ default?: number | undefined;
18
+ }, {
19
+ description: string;
20
+ zep_type: import("./base").ZepDataType.ZepFloat | import("./base").ZepDataType.ZepNumber;
21
+ value?: string | number | undefined;
22
+ default?: string | number | undefined;
23
+ }>, z.ZodObject<z.objectUtil.extendShape<{
24
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
25
+ description: z.ZodString;
26
+ }, {
27
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepText>, z.ZodLiteral<import("./base").ZepDataType.ZepZipCode>, z.ZodLiteral<import("./base").ZepDataType.ZepEmail>, z.ZodLiteral<import("./base").ZepDataType.ZepPhoneNumber>]>;
28
+ value: z.ZodOptional<z.ZodString>;
29
+ default: z.ZodOptional<z.ZodString>;
30
+ }>, "strip", z.ZodTypeAny, {
31
+ description: string;
32
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
33
+ value?: string | undefined;
34
+ default?: string | undefined;
35
+ }, {
36
+ description: string;
37
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
38
+ value?: string | undefined;
39
+ default?: string | undefined;
40
+ }>, z.ZodObject<z.objectUtil.extendShape<{
41
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
42
+ description: z.ZodString;
43
+ }, {
44
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepDate>, z.ZodLiteral<import("./base").ZepDataType.ZepDateTime>]>;
45
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, Date, string | Date>>;
46
+ }>, "strip", z.ZodTypeAny, {
47
+ description: string;
48
+ zep_type: import("./base").ZepDataType.ZepDate | import("./base").ZepDataType.ZepDateTime;
49
+ value?: Date | undefined;
50
+ }, {
51
+ description: string;
52
+ zep_type: import("./base").ZepDataType.ZepDate | import("./base").ZepDataType.ZepDateTime;
53
+ value?: string | Date | undefined;
54
+ }>, z.ZodObject<z.objectUtil.extendShape<{
55
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
56
+ description: z.ZodString;
57
+ }, {
58
+ zep_type: z.ZodLiteral<import("./base").ZepDataType.ZepRegex>;
59
+ value: z.ZodOptional<z.ZodString>;
60
+ pattern: z.ZodEffects<z.ZodString, string, string>;
61
+ default: z.ZodOptional<z.ZodString>;
62
+ }>, "strip", z.ZodTypeAny, {
63
+ description: string;
64
+ zep_type: import("./base").ZepDataType.ZepRegex;
65
+ pattern: string;
66
+ value?: string | undefined;
67
+ default?: string | undefined;
68
+ }, {
69
+ description: string;
70
+ zep_type: import("./base").ZepDataType.ZepRegex;
71
+ pattern: string;
72
+ value?: string | undefined;
73
+ default?: string | undefined;
74
+ }>]>>;
75
+ export declare type SupportedZepField = ZepNumberField | ZepDateField | ZepRegexField | ZepTextField;
76
+ export interface HasOptionalValue<V = any> {
77
+ value?: V;
78
+ }
79
+ /**
80
+ * Extracts the data types from the fields defined in the schema T. Each field in T
81
+ * is expected to conform to the HasOptionalValue interface, which optionally includes
82
+ * a 'value' of type V. This type definition maps each field in T to its corresponding
83
+ * 'value' type, but since 'value' is optional, the resulting type for each field also
84
+ * includes 'undefined'.
85
+ *
86
+ * @template T - The schema object from which to extract data types. Each property of T
87
+ * should implement the HasOptionalValue interface.
88
+ *
89
+ * @returns An object type with the same keys as T, but where the type of each key is
90
+ * either the type of 'value' in the corresponding field of T or 'undefined'
91
+ * if 'value' is optional.
92
+ *
93
+ * @example
94
+ * ```
95
+ * interface PersonSchema {
96
+ * name: HasOptionalValue<string>; // ZepTextField
97
+ * age: HasOptionalValue<number>; // ZepNumberField
98
+ * }
99
+ *
100
+ * type PersonData = ExtractedData<PersonSchema>;
101
+ * // PersonData would be equivalent to:
102
+ * // { name: string | undefined; age: number | undefined; }
103
+ * ```
104
+ * This example demonstrates how `ExtractedData` would transform a hypothetical `PersonSchema`
105
+ * into `PersonData`, clarifying how the types are derived and what to expect in the output.
106
+ */
107
+ export declare type ExtractedData<T> = {
108
+ [P in keyof T]: T[P] extends HasOptionalValue<infer V> ? V | undefined : never;
109
+ };
110
+ export declare const schemas: {
111
+ ZepNumber: z.ZodObject<z.objectUtil.extendShape<{
112
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
113
+ description: z.ZodString;
114
+ }, {
115
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepNumber>, z.ZodLiteral<import("./base").ZepDataType.ZepFloat>]>;
116
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
117
+ default: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
118
+ }>, "strip", z.ZodTypeAny, {
119
+ description: string;
120
+ zep_type: import("./base").ZepDataType.ZepFloat | import("./base").ZepDataType.ZepNumber;
121
+ value?: number | undefined;
122
+ default?: number | undefined;
123
+ }, {
124
+ description: string;
125
+ zep_type: import("./base").ZepDataType.ZepFloat | import("./base").ZepDataType.ZepNumber;
126
+ value?: string | number | undefined;
127
+ default?: string | number | undefined;
128
+ }>;
129
+ ZepText: z.ZodObject<z.objectUtil.extendShape<{
130
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
131
+ description: z.ZodString;
132
+ }, {
133
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepText>, z.ZodLiteral<import("./base").ZepDataType.ZepZipCode>, z.ZodLiteral<import("./base").ZepDataType.ZepEmail>, z.ZodLiteral<import("./base").ZepDataType.ZepPhoneNumber>]>;
134
+ value: z.ZodOptional<z.ZodString>;
135
+ default: z.ZodOptional<z.ZodString>;
136
+ }>, "strip", z.ZodTypeAny, {
137
+ description: string;
138
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
139
+ value?: string | undefined;
140
+ default?: string | undefined;
141
+ }, {
142
+ description: string;
143
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
144
+ value?: string | undefined;
145
+ default?: string | undefined;
146
+ }>;
147
+ ZepZipCode: z.ZodObject<z.objectUtil.extendShape<{
148
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
149
+ description: z.ZodString;
150
+ }, {
151
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepText>, z.ZodLiteral<import("./base").ZepDataType.ZepZipCode>, z.ZodLiteral<import("./base").ZepDataType.ZepEmail>, z.ZodLiteral<import("./base").ZepDataType.ZepPhoneNumber>]>;
152
+ value: z.ZodOptional<z.ZodString>;
153
+ default: z.ZodOptional<z.ZodString>;
154
+ }>, "strip", z.ZodTypeAny, {
155
+ description: string;
156
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
157
+ value?: string | undefined;
158
+ default?: string | undefined;
159
+ }, {
160
+ description: string;
161
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
162
+ value?: string | undefined;
163
+ default?: string | undefined;
164
+ }>;
165
+ ZepDate: z.ZodObject<z.objectUtil.extendShape<{
166
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
167
+ description: z.ZodString;
168
+ }, {
169
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepDate>, z.ZodLiteral<import("./base").ZepDataType.ZepDateTime>]>;
170
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, Date, string | Date>>;
171
+ }>, "strip", z.ZodTypeAny, {
172
+ description: string;
173
+ zep_type: import("./base").ZepDataType.ZepDate | import("./base").ZepDataType.ZepDateTime;
174
+ value?: Date | undefined;
175
+ }, {
176
+ description: string;
177
+ zep_type: import("./base").ZepDataType.ZepDate | import("./base").ZepDataType.ZepDateTime;
178
+ value?: string | Date | undefined;
179
+ }>;
180
+ ZepDateTime: z.ZodObject<z.objectUtil.extendShape<{
181
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
182
+ description: z.ZodString;
183
+ }, {
184
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepDate>, z.ZodLiteral<import("./base").ZepDataType.ZepDateTime>]>;
185
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, Date, string | Date>>;
186
+ }>, "strip", z.ZodTypeAny, {
187
+ description: string;
188
+ zep_type: import("./base").ZepDataType.ZepDate | import("./base").ZepDataType.ZepDateTime;
189
+ value?: Date | undefined;
190
+ }, {
191
+ description: string;
192
+ zep_type: import("./base").ZepDataType.ZepDate | import("./base").ZepDataType.ZepDateTime;
193
+ value?: string | Date | undefined;
194
+ }>;
195
+ ZepEmail: z.ZodObject<z.objectUtil.extendShape<{
196
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
197
+ description: z.ZodString;
198
+ }, {
199
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepText>, z.ZodLiteral<import("./base").ZepDataType.ZepZipCode>, z.ZodLiteral<import("./base").ZepDataType.ZepEmail>, z.ZodLiteral<import("./base").ZepDataType.ZepPhoneNumber>]>;
200
+ value: z.ZodOptional<z.ZodString>;
201
+ default: z.ZodOptional<z.ZodString>;
202
+ }>, "strip", z.ZodTypeAny, {
203
+ description: string;
204
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
205
+ value?: string | undefined;
206
+ default?: string | undefined;
207
+ }, {
208
+ description: string;
209
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
210
+ value?: string | undefined;
211
+ default?: string | undefined;
212
+ }>;
213
+ ZepPhoneNumber: z.ZodObject<z.objectUtil.extendShape<{
214
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
215
+ description: z.ZodString;
216
+ }, {
217
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepText>, z.ZodLiteral<import("./base").ZepDataType.ZepZipCode>, z.ZodLiteral<import("./base").ZepDataType.ZepEmail>, z.ZodLiteral<import("./base").ZepDataType.ZepPhoneNumber>]>;
218
+ value: z.ZodOptional<z.ZodString>;
219
+ default: z.ZodOptional<z.ZodString>;
220
+ }>, "strip", z.ZodTypeAny, {
221
+ description: string;
222
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
223
+ value?: string | undefined;
224
+ default?: string | undefined;
225
+ }, {
226
+ description: string;
227
+ zep_type: import("./base").ZepDataType.ZepText | import("./base").ZepDataType.ZepZipCode | import("./base").ZepDataType.ZepEmail | import("./base").ZepDataType.ZepPhoneNumber;
228
+ value?: string | undefined;
229
+ default?: string | undefined;
230
+ }>;
231
+ ZepFloat: z.ZodObject<z.objectUtil.extendShape<{
232
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
233
+ description: z.ZodString;
234
+ }, {
235
+ zep_type: z.ZodUnion<[z.ZodLiteral<import("./base").ZepDataType.ZepNumber>, z.ZodLiteral<import("./base").ZepDataType.ZepFloat>]>;
236
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
237
+ default: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
238
+ }>, "strip", z.ZodTypeAny, {
239
+ description: string;
240
+ zep_type: import("./base").ZepDataType.ZepFloat | import("./base").ZepDataType.ZepNumber;
241
+ value?: number | undefined;
242
+ default?: number | undefined;
243
+ }, {
244
+ description: string;
245
+ zep_type: import("./base").ZepDataType.ZepFloat | import("./base").ZepDataType.ZepNumber;
246
+ value?: string | number | undefined;
247
+ default?: string | number | undefined;
248
+ }>;
249
+ ZepRegex: z.ZodObject<z.objectUtil.extendShape<{
250
+ zep_type: z.ZodNativeEnum<typeof import("./base").ZepDataType>;
251
+ description: z.ZodString;
252
+ }, {
253
+ zep_type: z.ZodLiteral<import("./base").ZepDataType.ZepRegex>;
254
+ value: z.ZodOptional<z.ZodString>;
255
+ pattern: z.ZodEffects<z.ZodString, string, string>;
256
+ default: z.ZodOptional<z.ZodString>;
257
+ }>, "strip", z.ZodTypeAny, {
258
+ description: string;
259
+ zep_type: import("./base").ZepDataType.ZepRegex;
260
+ pattern: string;
261
+ value?: string | undefined;
262
+ default?: string | undefined;
263
+ }, {
264
+ description: string;
265
+ zep_type: import("./base").ZepDataType.ZepRegex;
266
+ pattern: string;
267
+ value?: string | undefined;
268
+ default?: string | undefined;
269
+ }>;
270
+ };
271
+ export declare const zepFields: {
272
+ number: (description: string) => ZepNumberField;
273
+ text: (description: string) => ZepTextField;
274
+ zipCode: (description: string) => ZepTextField;
275
+ date: (description: string) => ZepDateField;
276
+ dateTime: (description: string) => ZepDateField;
277
+ email: (description: string) => ZepTextField;
278
+ phoneNumber: (description: string) => ZepTextField;
279
+ float: (description: string) => ZepNumberField;
280
+ regex: (description: string, pattern: RegExp) => ZepRegexField;
281
+ };
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.zepFields = exports.schemas = exports.DataExtractorFields = void 0;
4
+ const zod_1 = require("zod");
5
+ const date_1 = require("./date");
6
+ const number_1 = require("./number");
7
+ const text_1 = require("./text");
8
+ const regex_1 = require("./regex");
9
+ exports.DataExtractorFields = zod_1.z.record(zod_1.z.union([number_1.ZepNumberSchema, text_1.ZepTextSchema, date_1.ZepDateSchema, regex_1.ZepRegexSchema]));
10
+ exports.schemas = {
11
+ ZepNumber: number_1.ZepNumberSchema,
12
+ ZepText: text_1.ZepTextSchema,
13
+ ZepZipCode: text_1.ZepTextSchema,
14
+ ZepDate: date_1.ZepDateSchema,
15
+ ZepDateTime: date_1.ZepDateSchema,
16
+ ZepEmail: text_1.ZepTextSchema,
17
+ ZepPhoneNumber: text_1.ZepTextSchema,
18
+ ZepFloat: number_1.ZepNumberSchema,
19
+ ZepRegex: regex_1.ZepRegexSchema,
20
+ };
21
+ exports.zepFields = {
22
+ number: number_1.zepNumberField,
23
+ text: text_1.zepTextField,
24
+ zipCode: text_1.zepZipcodeField,
25
+ date: date_1.zepDateField,
26
+ dateTime: date_1.zepDateTimeField,
27
+ email: text_1.zepEmailField,
28
+ phoneNumber: text_1.zepPhoneNumberField,
29
+ float: number_1.zepFloatField,
30
+ regex: regex_1.zepRegexField,
31
+ };
@@ -0,0 +1,27 @@
1
+ import { z } from "zod";
2
+ import { ZepDataType } from "./base";
3
+ import { HasOptionalValue } from "./index";
4
+ export declare const ZepNumberSchema: z.ZodObject<z.objectUtil.extendShape<{
5
+ zep_type: z.ZodNativeEnum<typeof ZepDataType>;
6
+ description: z.ZodString;
7
+ }, {
8
+ zep_type: z.ZodUnion<[z.ZodLiteral<ZepDataType.ZepNumber>, z.ZodLiteral<ZepDataType.ZepFloat>]>;
9
+ value: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
10
+ default: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
11
+ }>, "strip", z.ZodTypeAny, {
12
+ description: string;
13
+ zep_type: ZepDataType.ZepFloat | ZepDataType.ZepNumber;
14
+ value?: number | undefined;
15
+ default?: number | undefined;
16
+ }, {
17
+ description: string;
18
+ zep_type: ZepDataType.ZepFloat | ZepDataType.ZepNumber;
19
+ value?: string | number | undefined;
20
+ default?: string | number | undefined;
21
+ }>;
22
+ export interface ZepNumberField extends HasOptionalValue<number> {
23
+ zep_type: ZepDataType.ZepNumber | ZepDataType.ZepFloat;
24
+ description: string;
25
+ }
26
+ export declare const zepNumberField: (description: string) => ZepNumberField;
27
+ export declare const zepFloatField: (description: string) => ZepNumberField;
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.zepFloatField = exports.zepNumberField = exports.ZepNumberSchema = void 0;
4
+ const zod_1 = require("zod");
5
+ const base_1 = require("./base");
6
+ const stringToNumberTransformer = zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).transform((value, ctx) => {
7
+ if (typeof value === "string") {
8
+ const parsed = parseFloat(value);
9
+ if (isNaN(parsed)) {
10
+ ctx.addIssue({
11
+ code: zod_1.z.ZodIssueCode.custom,
12
+ message: "Not a number",
13
+ });
14
+ }
15
+ return parsed;
16
+ }
17
+ return value;
18
+ });
19
+ exports.ZepNumberSchema = base_1.BaseSchema.extend({
20
+ zep_type: zod_1.z.union([zod_1.z.literal(base_1.ZepDataType.ZepNumber), zod_1.z.literal(base_1.ZepDataType.ZepFloat)]),
21
+ value: stringToNumberTransformer.optional(),
22
+ default: stringToNumberTransformer.optional(),
23
+ });
24
+ const zepNumberField = (description) => {
25
+ return exports.ZepNumberSchema.parse({
26
+ zep_type: base_1.ZepDataType.ZepNumber,
27
+ description,
28
+ });
29
+ };
30
+ exports.zepNumberField = zepNumberField;
31
+ const zepFloatField = (description) => {
32
+ return exports.ZepNumberSchema.parse({
33
+ zep_type: base_1.ZepDataType.ZepFloat,
34
+ description,
35
+ });
36
+ };
37
+ exports.zepFloatField = zepFloatField;
@@ -0,0 +1,30 @@
1
+ import { z } from "zod";
2
+ import { ZepDataType } from "./base";
3
+ import { HasOptionalValue } from "./index";
4
+ export declare const ZepRegexSchema: z.ZodObject<z.objectUtil.extendShape<{
5
+ zep_type: z.ZodNativeEnum<typeof ZepDataType>;
6
+ description: z.ZodString;
7
+ }, {
8
+ zep_type: z.ZodLiteral<ZepDataType.ZepRegex>;
9
+ value: z.ZodOptional<z.ZodString>;
10
+ pattern: z.ZodEffects<z.ZodString, string, string>;
11
+ default: z.ZodOptional<z.ZodString>;
12
+ }>, "strip", z.ZodTypeAny, {
13
+ description: string;
14
+ zep_type: ZepDataType.ZepRegex;
15
+ pattern: string;
16
+ value?: string | undefined;
17
+ default?: string | undefined;
18
+ }, {
19
+ description: string;
20
+ zep_type: ZepDataType.ZepRegex;
21
+ pattern: string;
22
+ value?: string | undefined;
23
+ default?: string | undefined;
24
+ }>;
25
+ export interface ZepRegexField extends HasOptionalValue<string> {
26
+ zep_type: ZepDataType.ZepRegex;
27
+ description: string;
28
+ pattern: string;
29
+ }
30
+ export declare const zepRegexField: (description: string, pattern: RegExp) => ZepRegexField;
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.zepRegexField = exports.ZepRegexSchema = void 0;
4
+ const zod_1 = require("zod");
5
+ const base_1 = require("./base");
6
+ exports.ZepRegexSchema = base_1.BaseSchema.extend({
7
+ zep_type: zod_1.z.literal(base_1.ZepDataType.ZepRegex),
8
+ value: zod_1.z.string().optional(),
9
+ pattern: zod_1.z.string().refine((p) => {
10
+ try {
11
+ new RegExp(p);
12
+ return true; // Pattern is valid
13
+ }
14
+ catch (_a) {
15
+ return false; // Pattern is invalid
16
+ }
17
+ }, {
18
+ message: "Invalid regex pattern", // Custom error message
19
+ }),
20
+ default: zod_1.z.string().optional(),
21
+ });
22
+ const zepRegexField = (description, pattern) => {
23
+ return exports.ZepRegexSchema.parse({
24
+ zep_type: base_1.ZepDataType.ZepRegex,
25
+ pattern: pattern.source,
26
+ description,
27
+ });
28
+ };
29
+ exports.zepRegexField = zepRegexField;
@@ -0,0 +1,29 @@
1
+ import { z } from "zod";
2
+ import { ZepDataType } from "./base";
3
+ import { HasOptionalValue } from "./index";
4
+ export declare const ZepTextSchema: z.ZodObject<z.objectUtil.extendShape<{
5
+ zep_type: z.ZodNativeEnum<typeof ZepDataType>;
6
+ description: z.ZodString;
7
+ }, {
8
+ zep_type: z.ZodUnion<[z.ZodLiteral<ZepDataType.ZepText>, z.ZodLiteral<ZepDataType.ZepZipCode>, z.ZodLiteral<ZepDataType.ZepEmail>, z.ZodLiteral<ZepDataType.ZepPhoneNumber>]>;
9
+ value: z.ZodOptional<z.ZodString>;
10
+ default: z.ZodOptional<z.ZodString>;
11
+ }>, "strip", z.ZodTypeAny, {
12
+ description: string;
13
+ zep_type: ZepDataType.ZepText | ZepDataType.ZepZipCode | ZepDataType.ZepEmail | ZepDataType.ZepPhoneNumber;
14
+ value?: string | undefined;
15
+ default?: string | undefined;
16
+ }, {
17
+ description: string;
18
+ zep_type: ZepDataType.ZepText | ZepDataType.ZepZipCode | ZepDataType.ZepEmail | ZepDataType.ZepPhoneNumber;
19
+ value?: string | undefined;
20
+ default?: string | undefined;
21
+ }>;
22
+ export interface ZepTextField extends HasOptionalValue<string> {
23
+ zep_type: ZepDataType.ZepText | ZepDataType.ZepZipCode | ZepDataType.ZepEmail | ZepDataType.ZepPhoneNumber;
24
+ description: string;
25
+ }
26
+ export declare const zepTextField: (description: string) => ZepTextField;
27
+ export declare const zepZipcodeField: (description: string) => ZepTextField;
28
+ export declare const zepPhoneNumberField: (description: string) => ZepTextField;
29
+ export declare const zepEmailField: (description: string) => ZepTextField;
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.zepEmailField = exports.zepPhoneNumberField = exports.zepZipcodeField = exports.zepTextField = exports.ZepTextSchema = void 0;
4
+ const zod_1 = require("zod");
5
+ const base_1 = require("./base");
6
+ exports.ZepTextSchema = base_1.BaseSchema.extend({
7
+ zep_type: zod_1.z.union([
8
+ zod_1.z.literal(base_1.ZepDataType.ZepText),
9
+ zod_1.z.literal(base_1.ZepDataType.ZepZipCode),
10
+ zod_1.z.literal(base_1.ZepDataType.ZepEmail),
11
+ zod_1.z.literal(base_1.ZepDataType.ZepPhoneNumber),
12
+ ]),
13
+ value: zod_1.z.string().optional(),
14
+ default: zod_1.z.string().optional(),
15
+ });
16
+ const zepTextField = (description) => {
17
+ return exports.ZepTextSchema.parse({
18
+ zep_type: base_1.ZepDataType.ZepText,
19
+ description,
20
+ });
21
+ };
22
+ exports.zepTextField = zepTextField;
23
+ const zepZipcodeField = (description) => {
24
+ return exports.ZepTextSchema.parse({
25
+ zep_type: base_1.ZepDataType.ZepZipCode,
26
+ description,
27
+ });
28
+ };
29
+ exports.zepZipcodeField = zepZipcodeField;
30
+ const zepPhoneNumberField = (description) => {
31
+ return exports.ZepTextSchema.parse({
32
+ zep_type: base_1.ZepDataType.ZepPhoneNumber,
33
+ description,
34
+ });
35
+ };
36
+ exports.zepPhoneNumberField = zepPhoneNumberField;
37
+ const zepEmailField = (description) => {
38
+ return exports.ZepTextSchema.parse({
39
+ zep_type: base_1.ZepDataType.ZepEmail,
40
+ description,
41
+ });
42
+ };
43
+ exports.zepEmailField = zepEmailField;
package/dist/index.d.ts CHANGED
@@ -2,3 +2,4 @@ export * as Zep from "./api";
2
2
  export { ZepClient } from "./wrapper";
3
3
  export { ZepEnvironment } from "./environments";
4
4
  export { ZepError, ZepTimeoutError } from "./errors";
5
+ export { zepFields } from "./extractor";
package/dist/index.js CHANGED
@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
23
23
  return result;
24
24
  };
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.ZepTimeoutError = exports.ZepError = exports.ZepEnvironment = exports.ZepClient = exports.Zep = void 0;
26
+ exports.zepFields = exports.ZepTimeoutError = exports.ZepError = exports.ZepEnvironment = exports.ZepClient = exports.Zep = void 0;
27
27
  exports.Zep = __importStar(require("./api"));
28
28
  var wrapper_1 = require("./wrapper");
29
29
  Object.defineProperty(exports, "ZepClient", { enumerable: true, get: function () { return wrapper_1.ZepClient; } });
@@ -32,3 +32,5 @@ Object.defineProperty(exports, "ZepEnvironment", { enumerable: true, get: functi
32
32
  var errors_1 = require("./errors");
33
33
  Object.defineProperty(exports, "ZepError", { enumerable: true, get: function () { return errors_1.ZepError; } });
34
34
  Object.defineProperty(exports, "ZepTimeoutError", { enumerable: true, get: function () { return errors_1.ZepTimeoutError; } });
35
+ var extractor_1 = require("./extractor");
36
+ Object.defineProperty(exports, "zepFields", { enumerable: true, get: function () { return extractor_1.zepFields; } });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as core from "../../../../core";
6
+ export declare const Response: core.serialization.Schema<serializers.memory.extractData.Response.Raw, Record<string, string>>;
7
+ export declare namespace Response {
8
+ type Raw = Record<string, string>;
9
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.Response = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ exports.Response = core.serialization.record(core.serialization.string(), core.serialization.string());
@@ -1,2 +1,3 @@
1
+ export * as extractData from "./extractData";
1
2
  export * as search from "./search";
2
3
  export * from "./requests";