@unito/integration-api 7.0.0 → 7.0.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.
@@ -30,6 +30,7 @@
30
30
  "createdAt",
31
31
  "description",
32
32
  "displayName",
33
+ "isPublic",
33
34
  "providerUrl",
34
35
  "updatedAt",
35
36
  "user",
@@ -32,6 +32,17 @@ const Semantics = {
32
32
  CREATED_AT: 'createdAt',
33
33
  DESCRIPTION: 'description',
34
34
  DISPLAY_NAME: 'displayName',
35
+ /**
36
+ * Indicates whether an item is publicly visible.
37
+ * For example, a comment marked as public is visible to external users.
38
+ *
39
+ * Expected field value to be of type FieldValueType.BOOLEAN.
40
+ * `true` means the item is public, `false` means it is private/internal.
41
+ *
42
+ * Integrations should map their provider's visibility field directly — e.g.,
43
+ * a Salesforce field named `Public` maps to `IS_PUBLIC` with the same polarity.
44
+ */
45
+ IS_PUBLIC: 'isPublic',
35
46
  PROVIDER_URL: 'providerUrl',
36
47
  UPDATED_AT: 'updatedAt',
37
48
  USER: 'user',
@@ -124,11 +124,15 @@ interface DisplayNameFieldSchema extends AbstractFieldSchema {
124
124
  semantic: typeof Semantics.DISPLAY_NAME;
125
125
  type: typeof FieldValueTypes.STRING | typeof FieldValueTypes.EMAIL;
126
126
  }
127
+ interface IsPublicFieldSchema extends AbstractFieldSchema {
128
+ semantic: typeof Semantics.IS_PUBLIC;
129
+ type: typeof FieldValueTypes.BOOLEAN;
130
+ }
127
131
  interface UnconstrainedBasicFieldSchema extends AbstractFieldSchema {
128
132
  semantic?: never;
129
133
  type: BasicFieldValueType;
130
134
  }
131
- export type BasicFieldSchema = ProviderUrlFieldSchema | CreatedAtFieldSchema | UpdatedAtFieldSchema | DescriptionFieldSchema | DisplayNameFieldSchema | UnconstrainedBasicFieldSchema;
135
+ export type BasicFieldSchema = ProviderUrlFieldSchema | CreatedAtFieldSchema | UpdatedAtFieldSchema | DescriptionFieldSchema | DisplayNameFieldSchema | IsPublicFieldSchema | UnconstrainedBasicFieldSchema;
132
136
  export interface BlobFieldSchema extends AbstractFieldSchema {
133
137
  /**
134
138
  * The type of the field.
@@ -263,6 +267,17 @@ export declare const Semantics: {
263
267
  readonly CREATED_AT: "createdAt";
264
268
  readonly DESCRIPTION: "description";
265
269
  readonly DISPLAY_NAME: "displayName";
270
+ /**
271
+ * Indicates whether an item is publicly visible.
272
+ * For example, a comment marked as public is visible to external users.
273
+ *
274
+ * Expected field value to be of type FieldValueType.BOOLEAN.
275
+ * `true` means the item is public, `false` means it is private/internal.
276
+ *
277
+ * Integrations should map their provider's visibility field directly — e.g.,
278
+ * a Salesforce field named `Public` maps to `IS_PUBLIC` with the same polarity.
279
+ */
280
+ readonly IS_PUBLIC: "isPublic";
266
281
  readonly PROVIDER_URL: "providerUrl";
267
282
  readonly UPDATED_AT: "updatedAt";
268
283
  readonly USER: "user";
package/dist/src/types.js CHANGED
@@ -30,6 +30,17 @@ export const Semantics = {
30
30
  CREATED_AT: 'createdAt',
31
31
  DESCRIPTION: 'description',
32
32
  DISPLAY_NAME: 'displayName',
33
+ /**
34
+ * Indicates whether an item is publicly visible.
35
+ * For example, a comment marked as public is visible to external users.
36
+ *
37
+ * Expected field value to be of type FieldValueType.BOOLEAN.
38
+ * `true` means the item is public, `false` means it is private/internal.
39
+ *
40
+ * Integrations should map their provider's visibility field directly — e.g.,
41
+ * a Salesforce field named `Public` maps to `IS_PUBLIC` with the same polarity.
42
+ */
43
+ IS_PUBLIC: 'isPublic',
33
44
  PROVIDER_URL: 'providerUrl',
34
45
  UPDATED_AT: 'updatedAt',
35
46
  USER: 'user',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unito/integration-api",
3
- "version": "7.0.0",
3
+ "version": "7.0.1",
4
4
  "description": "The Unito Integration API",
5
5
  "type": "module",
6
6
  "types": "./dist/src/index.d.ts",