@macro-inc/sdk 0.3.0 → 0.4.0

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 (100) hide show
  1. package/README.md +45 -0
  2. package/dist/{chunk-Y4HQV7EL.js → chunk-AZJUIUIV.js} +26 -0
  3. package/dist/{chunk-KPR5JIGY.js → chunk-G43PLP2U.js} +95 -0
  4. package/dist/{chunk-IIICUUWY.js → chunk-PPR7IWZ7.js} +51 -51
  5. package/dist/{chunk-PTMBRVEK.js → chunk-PTX2RV2N.js} +84 -0
  6. package/dist/{chunk-OEHZOKGE.js → chunk-PZPTJI6F.js} +16 -0
  7. package/dist/{chunk-HR32RQGP.js → chunk-ZLBDES7U.js} +307 -1
  8. package/dist/generated/agent-fold/index.d.ts +6 -1
  9. package/dist/generated/agent-harness/index.d.ts +1 -1
  10. package/dist/generated/agent-harness/index.js +1 -1
  11. package/dist/generated/agent-harness/sdk.gen.d.ts +44 -1
  12. package/dist/generated/agent-harness/types.gen.d.ts +699 -0
  13. package/dist/generated/calendar/index.d.ts +1 -1
  14. package/dist/generated/calendar/index.js +1 -1
  15. package/dist/generated/calendar/sdk.gen.d.ts +41 -1
  16. package/dist/generated/calendar/types.gen.d.ts +904 -2
  17. package/dist/generated/cognition/index.d.ts +1 -1
  18. package/dist/generated/cognition/index.js +1 -1
  19. package/dist/generated/cognition/sdk.gen.d.ts +9 -1
  20. package/dist/generated/cognition/types.gen.d.ts +79 -0
  21. package/dist/generated/email/types.gen.d.ts +11 -1
  22. package/dist/generated/notification/index.js +1 -1
  23. package/dist/generated/notification/sdk.gen.d.ts +20 -20
  24. package/dist/generated/notification/types.gen.d.ts +77 -72
  25. package/dist/generated/scheduled-action/index.d.ts +1 -1
  26. package/dist/generated/scheduled-action/index.js +1 -1
  27. package/dist/generated/scheduled-action/sdk.gen.d.ts +4 -1
  28. package/dist/generated/scheduled-action/types.gen.d.ts +388 -7
  29. package/dist/generated/storage/index.d.ts +1 -1
  30. package/dist/generated/storage/index.js +1 -1
  31. package/dist/generated/storage/sdk.gen.d.ts +151 -1
  32. package/dist/generated/storage/types.gen.d.ts +3888 -139
  33. package/dist/src/entities/account-managers/grant.d.ts +39 -0
  34. package/dist/src/entities/account-managers/namespace.d.ts +17 -0
  35. package/dist/src/entities/agent-sessions/activity.d.ts +39 -0
  36. package/dist/src/entities/agent-sessions/agent-session.d.ts +42 -0
  37. package/dist/src/entities/agent-sessions/namespace.d.ts +7 -1
  38. package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
  39. package/dist/src/entities/ai/namespace.d.ts +1 -1
  40. package/dist/src/entities/bots/bot.d.ts +108 -0
  41. package/dist/src/entities/bots/namespace.d.ts +15 -4
  42. package/dist/src/entities/bots/token.d.ts +34 -0
  43. package/dist/src/entities/calendar/booking-link.d.ts +49 -0
  44. package/dist/src/entities/calendar/booking-namespace.d.ts +130 -0
  45. package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
  46. package/dist/src/entities/calendar/booking.d.ts +77 -0
  47. package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
  48. package/dist/src/entities/calendar/namespace.d.ts +63 -15
  49. package/dist/src/entities/calls/call-record.d.ts +25 -3
  50. package/dist/src/entities/calls/connection.d.ts +53 -0
  51. package/dist/src/entities/calls/errors.d.ts +15 -0
  52. package/dist/src/entities/calls/namespace.d.ts +19 -2
  53. package/dist/src/entities/calls/participant.d.ts +22 -0
  54. package/dist/src/entities/channels/channel.d.ts +21 -3
  55. package/dist/src/entities/channels/namespace.d.ts +3 -3
  56. package/dist/src/entities/channels/post.d.ts +10 -2
  57. package/dist/src/entities/channels/thread.d.ts +4 -0
  58. package/dist/src/entities/chats/chat.d.ts +1 -1
  59. package/dist/src/entities/chats/namespace.d.ts +14 -1
  60. package/dist/src/entities/connected-apps/connected-app.d.ts +107 -0
  61. package/dist/src/entities/connected-apps/connector.d.ts +56 -0
  62. package/dist/src/entities/connected-apps/namespace.d.ts +74 -0
  63. package/dist/src/entities/crm/company.d.ts +1 -1
  64. package/dist/src/entities/crm/pipeline.d.ts +1 -1
  65. package/dist/src/entities/documents/document.d.ts +156 -7
  66. package/dist/src/entities/documents/namespace.d.ts +41 -2
  67. package/dist/src/entities/documents/office-files.d.ts +47 -0
  68. package/dist/src/entities/email/draft.d.ts +26 -4
  69. package/dist/src/entities/email/message.d.ts +91 -1
  70. package/dist/src/entities/email/namespace.d.ts +26 -3
  71. package/dist/src/entities/email/namespace.test.d.ts +1 -0
  72. package/dist/src/entities/email/thread.d.ts +7 -2
  73. package/dist/src/entities/external-chat/namespace.d.ts +2 -0
  74. package/dist/src/entities/favorites/namespace.d.ts +1 -1
  75. package/dist/src/entities/harnesses/namespace.d.ts +5 -1
  76. package/dist/src/entities/images/namespace.d.ts +5 -1
  77. package/dist/src/entities/me/namespace.d.ts +5 -1
  78. package/dist/src/entities/meetings/meeting.d.ts +5 -0
  79. package/dist/src/entities/messages/thread.d.ts +1 -1
  80. package/dist/src/entities/pins/namespace.d.ts +1 -1
  81. package/dist/src/entities/projects/namespace.d.ts +1 -1
  82. package/dist/src/entities/projects/project.d.ts +1 -1
  83. package/dist/src/entities/search/namespace.d.ts +65 -0
  84. package/dist/src/entities/search/options.d.ts +29 -0
  85. package/dist/src/entities/search/types.d.ts +90 -0
  86. package/dist/src/entities/tasks/namespace.d.ts +1 -1
  87. package/dist/src/entities/tasks/task.d.ts +4 -3
  88. package/dist/src/entities/users/namespace.d.ts +1 -1
  89. package/dist/src/entities/whatsapp/namespace.d.ts +2 -0
  90. package/dist/src/entities/workspace/items.d.ts +7 -0
  91. package/dist/src/entities/workspace/namespace.d.ts +14 -9
  92. package/dist/src/entities/workspace/query.d.ts +23 -0
  93. package/dist/src/entities/workspace/types.d.ts +6 -3
  94. package/dist/src/events/hydrate/call.d.ts +101 -0
  95. package/dist/src/events/types.d.ts +2 -1
  96. package/dist/src/macro.d.ts +33 -1
  97. package/dist/src/macro.js +6423 -4265
  98. package/dist/src/utils/activity.d.ts +23 -2
  99. package/package.json +1 -1
  100. package/dist/src/entities/search.d.ts +0 -53
@@ -1,11 +1,32 @@
1
- /** A generated SDK operation lifecycle. Contains no arguments, URLs or response data. */
1
+ /**
2
+ * A generated SDK operation lifecycle. Contains no arguments, URLs or response
3
+ * data. A gated operation is `skipped` (answered without calling the API) or
4
+ * `refused` (rejected), with no `started` before it.
5
+ */
2
6
  export type RequestActivity = {
3
7
  id: number;
4
8
  service: string;
5
9
  operation: string;
6
- status: 'started' | 'completed' | 'failed';
10
+ status: 'started' | 'completed' | 'failed' | 'skipped' | 'refused';
11
+ };
12
+ /** What a gate decides for one operation; `undefined` lets it run. */
13
+ export type RequestVerdict = undefined | {
14
+ skip: {
15
+ data: unknown;
16
+ };
17
+ } | {
18
+ refuse: string;
7
19
  };
8
20
  /** @internal Install runtime diagnostics before constructing SDK clients. */
9
21
  export declare function setDefaultRequestObserver(observer: (event: RequestActivity) => void): void;
22
+ /**
23
+ * @internal Decide, before each generated API operation, whether it runs, is
24
+ * answered with a stand-in result, or is refused. Install it before
25
+ * constructing SDK clients.
26
+ */
27
+ export declare function setDefaultRequestGate(gate: (operation: {
28
+ service: string;
29
+ operation: string;
30
+ }) => RequestVerdict): void;
10
31
  /** @internal Observe generated API operations without changing arguments or results. */
11
32
  export declare function observeSdk<T extends object>(sdk: T, service: string, observer?: (event: RequestActivity) => void): T;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@macro-inc/sdk",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/macro-inc/macro.git",
@@ -1,53 +0,0 @@
1
- /**
2
- * Search across the user's Macro content.
3
- *
4
- * @routing Use when finding, looking up or listing the user's own Macro content across documents, messages, email or calls, or asking something their workspace answers; not the web, and not one item already in context.
5
- *
6
- * @agent
7
- * Search within the user's requested entities. macro.documents.search returns document handles; macro.email.search returns email threads. SearchOpts selects searchOn: 'name', 'content', or 'name_content'. These SDK iterators auto-paginate when the backend returns a cursor. Explicitly bound work; record when you stop before exhaustion. Do not carry over the old tool response's {results} wrapper or its fixed no-cursor contract.
8
- *
9
- * ```javascript
10
- * export async function main({macro}) {
11
- * const queries = ['launch decision', 'release readiness'];
12
- * const outcomes = await Promise.allSettled(queries.map(async query => {
13
- * const evidence = [];
14
- * let stoppedEarly = false;
15
- * for await (const document of macro.documents.search(query, {searchOn:'content'})) {
16
- * if (evidence.length === 5) { stoppedEarly = true; break; }
17
- * evidence.push({id:document.id, text:(await document.content()).slice(0,3000)});
18
- * }
19
- * return {query,evidence,stoppedEarly};
20
- * }));
21
- * return {data: outcomes.map((item,index) => item.status === 'fulfilled'
22
- * ? item.value : {query:queries[index],error:String(item.reason)}), reviews:[]};
23
- * }
24
- * ```
25
- * Preserve useful evidence from each query. A short sample cannot establish corpus-wide completeness or absence. Use precise terms, metadata and relevant reads before expanding breadth. Do not swallow rejected branches. Normal for/while/for-await with break and sequential dependent calls are supported.
26
- *
27
- * Skills are documents. When a request names a skill that is not attached, find it by name with macro.documents.search(name, {searchOn:'name'}), read its instructions with content() before doing the task, and follow them for that request only. Built-in system skills (macro.documents.systemSkills()) have no document; read them with the ReadSkill tool.
28
- *
29
- * @packageDocumentation
30
- */
31
- import type { EntityFilters, UnifiedSearchResponseItem } from '../../generated/search/types.gen';
32
- import type { MacroClient } from '../utils/client';
33
- type Hit = UnifiedSearchResponseItem;
34
- export type SearchOn = 'name' | 'content' | 'name_content';
35
- export interface SearchOpts {
36
- searchOn?: SearchOn;
37
- pageSize?: number;
38
- }
39
- /**
40
- * Build a `search(client, query, opts?)` function for one entity type: unified
41
- * search hits narrowed to `type`, each mapped through `make`.
42
- * Most relevant first, auto-paginated.
43
- */
44
- export declare function entitySearch<T, K extends Hit['type']>(opts: {
45
- filters?: EntityFilters;
46
- type: K;
47
- make: (client: MacroClient, hit: Extract<Hit, {
48
- type: K;
49
- }>) => T;
50
- /** Opt in to CRM results (off by default server-side; required for company hits). */
51
- includeCrm?: boolean;
52
- }): (client: MacroClient, query: string, searchOpts?: SearchOpts) => AsyncGenerator<T>;
53
- export {};