@junobuild/core-peer 0.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.
Files changed (66) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +25 -0
  3. package/declarations/deprecated/mission_control-0-0-4.did.d.ts +80 -0
  4. package/declarations/deprecated/mission_control-0-0-4.factory.did.js +99 -0
  5. package/declarations/deprecated/satellite-0-0-8.did.d.ts +183 -0
  6. package/declarations/deprecated/satellite-0-0-8.factory.did.js +194 -0
  7. package/declarations/deprecated/satellite-0-0-9.did.d.ts +199 -0
  8. package/declarations/deprecated/satellite-0-0-9.factory.did.js +213 -0
  9. package/declarations/satellite/index.d.ts +45 -0
  10. package/declarations/satellite/index.js +37 -0
  11. package/declarations/satellite/satellite.did.d.ts +207 -0
  12. package/declarations/satellite/satellite.factory.did.js +221 -0
  13. package/declarations/satellite/satellite.factory.did.mjs +221 -0
  14. package/dist/browser/index.js +2 -0
  15. package/dist/browser/index.js.map +7 -0
  16. package/dist/declarations/deprecated/mission_control-0-0-4.did.d.ts +80 -0
  17. package/dist/declarations/deprecated/mission_control-0-0-4.factory.did.js +99 -0
  18. package/dist/declarations/deprecated/satellite-0-0-8.did.d.ts +183 -0
  19. package/dist/declarations/deprecated/satellite-0-0-8.factory.did.js +194 -0
  20. package/dist/declarations/deprecated/satellite-0-0-9.did.d.ts +199 -0
  21. package/dist/declarations/deprecated/satellite-0-0-9.factory.did.js +213 -0
  22. package/dist/declarations/satellite/index.d.ts +45 -0
  23. package/dist/declarations/satellite/index.js +37 -0
  24. package/dist/declarations/satellite/satellite.did.d.ts +207 -0
  25. package/dist/declarations/satellite/satellite.factory.did.js +221 -0
  26. package/dist/declarations/satellite/satellite.factory.did.mjs +221 -0
  27. package/dist/index.js +1 -0
  28. package/dist/node/index.mjs +4 -0
  29. package/dist/node/index.mjs.map +7 -0
  30. package/dist/types/api/actor.api.d.ts +3 -0
  31. package/dist/types/api/doc.api.d.ts +22 -0
  32. package/dist/types/api/storage.api.d.ts +20 -0
  33. package/dist/types/constants/auth.constants.d.ts +11 -0
  34. package/dist/types/index.d.ts +16 -0
  35. package/dist/types/providers/auth.providers.d.ts +31 -0
  36. package/dist/types/services/auth-timout.services.d.ts +3 -0
  37. package/dist/types/services/auth.services.d.ts +11 -0
  38. package/dist/types/services/doc.services.d.ts +22 -0
  39. package/dist/types/services/identity.services.d.ts +2 -0
  40. package/dist/types/services/storage.services.d.ts +24 -0
  41. package/dist/types/services/user.services.d.ts +2 -0
  42. package/dist/types/stores/auth.store.d.ts +13 -0
  43. package/dist/types/stores/env.store.d.ts +12 -0
  44. package/dist/types/stores/store.d.ts +5 -0
  45. package/dist/types/types/auth.types.d.ts +13 -0
  46. package/dist/types/types/doc.types.d.ts +8 -0
  47. package/dist/types/types/env.types.d.ts +10 -0
  48. package/dist/types/types/list.types.d.ts +28 -0
  49. package/dist/types/types/post-message.d.ts +5 -0
  50. package/dist/types/types/satellite.types.d.ts +8 -0
  51. package/dist/types/types/storage.types.d.ts +35 -0
  52. package/dist/types/types/subscription.types.d.ts +1 -0
  53. package/dist/types/utils/actor.utils.d.ts +6 -0
  54. package/dist/types/utils/auth.utils.d.ts +2 -0
  55. package/dist/types/utils/crypto.utils.d.ts +1 -0
  56. package/dist/types/utils/data.utils.d.ts +2 -0
  57. package/dist/types/utils/env.utils.d.ts +1 -0
  58. package/dist/types/utils/events.utils.d.ts +4 -0
  59. package/dist/types/utils/list.utils.d.ts +3 -0
  60. package/dist/types/utils/storage.utils.d.ts +1 -0
  61. package/dist/types/utils/window.utils.d.ts +4 -0
  62. package/dist/types/workers/auth.worker.d.ts +6 -0
  63. package/dist/workers/auth.worker.js +25 -0
  64. package/dist/workers/auth.worker.js.gz +0 -0
  65. package/dist/workers/auth.worker.js.map +7 -0
  66. package/package.json +66 -0
@@ -0,0 +1,199 @@
1
+ import type {ActorMethod} from '@dfinity/agent';
2
+ import type {Principal} from '@dfinity/principal';
3
+
4
+ export interface AssetEncodingNoContent {
5
+ modified: bigint;
6
+ sha256: Uint8Array | number[];
7
+ total_length: bigint;
8
+ }
9
+ export interface AssetKey {
10
+ token: [] | [string];
11
+ collection: string;
12
+ owner: Principal;
13
+ name: string;
14
+ description: [] | [string];
15
+ full_path: string;
16
+ }
17
+ export interface AssetNoContent {
18
+ key: AssetKey;
19
+ updated_at: bigint;
20
+ encodings: Array<[string, AssetEncodingNoContent]>;
21
+ headers: Array<[string, string]>;
22
+ created_at: bigint;
23
+ }
24
+ export interface Chunk {
25
+ content: Uint8Array | number[];
26
+ batch_id: bigint;
27
+ }
28
+ export interface CommitBatch {
29
+ batch_id: bigint;
30
+ headers: Array<[string, string]>;
31
+ chunk_ids: Array<bigint>;
32
+ }
33
+ export interface Config {
34
+ storage: StorageConfig;
35
+ }
36
+ export interface Controller {
37
+ updated_at: bigint;
38
+ metadata: Array<[string, string]>;
39
+ created_at: bigint;
40
+ scope: ControllerScope;
41
+ expires_at: [] | [bigint];
42
+ }
43
+ export type ControllerScope = {Write: null} | {Admin: null};
44
+ export interface CustomDomain {
45
+ updated_at: bigint;
46
+ created_at: bigint;
47
+ bn_id: [] | [string];
48
+ }
49
+ export interface DelDoc {
50
+ updated_at: [] | [bigint];
51
+ }
52
+ export interface DeleteControllersArgs {
53
+ controllers: Array<Principal>;
54
+ }
55
+ export interface Doc {
56
+ updated_at: bigint;
57
+ owner: Principal;
58
+ data: Uint8Array | number[];
59
+ description: [] | [string];
60
+ created_at: bigint;
61
+ }
62
+ export interface HttpRequest {
63
+ url: string;
64
+ method: string;
65
+ body: Uint8Array | number[];
66
+ headers: Array<[string, string]>;
67
+ }
68
+ export interface HttpResponse {
69
+ body: Uint8Array | number[];
70
+ headers: Array<[string, string]>;
71
+ streaming_strategy: [] | [StreamingStrategy];
72
+ status_code: number;
73
+ }
74
+ export interface InitAssetKey {
75
+ token: [] | [string];
76
+ collection: string;
77
+ name: string;
78
+ description: [] | [string];
79
+ encoding_type: [] | [string];
80
+ full_path: string;
81
+ }
82
+ export interface InitUploadResult {
83
+ batch_id: bigint;
84
+ }
85
+ export interface ListMatcher {
86
+ key: [] | [string];
87
+ description: [] | [string];
88
+ }
89
+ export interface ListOrder {
90
+ field: ListOrderField;
91
+ desc: boolean;
92
+ }
93
+ export type ListOrderField = {UpdatedAt: null} | {Keys: null} | {CreatedAt: null};
94
+ export interface ListPaginate {
95
+ start_after: [] | [string];
96
+ limit: [] | [bigint];
97
+ }
98
+ export interface ListParams {
99
+ order: [] | [ListOrder];
100
+ owner: [] | [Principal];
101
+ matcher: [] | [ListMatcher];
102
+ paginate: [] | [ListPaginate];
103
+ }
104
+ export interface ListResults {
105
+ matches_pages: [] | [bigint];
106
+ matches_length: bigint;
107
+ items_page: [] | [bigint];
108
+ items: Array<[string, AssetNoContent]>;
109
+ items_length: bigint;
110
+ }
111
+ export interface ListResults_1 {
112
+ matches_pages: [] | [bigint];
113
+ matches_length: bigint;
114
+ items_page: [] | [bigint];
115
+ items: Array<[string, Doc]>;
116
+ items_length: bigint;
117
+ }
118
+ export type Permission = {Controllers: null} | {Private: null} | {Public: null} | {Managed: null};
119
+ export interface Rule {
120
+ updated_at: bigint;
121
+ max_size: [] | [bigint];
122
+ read: Permission;
123
+ created_at: bigint;
124
+ write: Permission;
125
+ }
126
+ export type RulesType = {Db: null} | {Storage: null};
127
+ export interface SetController {
128
+ metadata: Array<[string, string]>;
129
+ scope: ControllerScope;
130
+ expires_at: [] | [bigint];
131
+ }
132
+ export interface SetControllersArgs {
133
+ controller: SetController;
134
+ controllers: Array<Principal>;
135
+ }
136
+ export interface SetDoc {
137
+ updated_at: [] | [bigint];
138
+ data: Uint8Array | number[];
139
+ description: [] | [string];
140
+ }
141
+ export interface SetRule {
142
+ updated_at: [] | [bigint];
143
+ max_size: [] | [bigint];
144
+ read: Permission;
145
+ write: Permission;
146
+ }
147
+ export interface StorageConfig {
148
+ headers: Array<[string, Array<[string, string]>]>;
149
+ }
150
+ export interface StreamingCallbackHttpResponse {
151
+ token: [] | [StreamingCallbackToken];
152
+ body: Uint8Array | number[];
153
+ }
154
+ export interface StreamingCallbackToken {
155
+ token: [] | [string];
156
+ sha256: [] | [Uint8Array | number[]];
157
+ headers: Array<[string, string]>;
158
+ index: bigint;
159
+ encoding_type: string;
160
+ full_path: string;
161
+ }
162
+ export type StreamingStrategy = {
163
+ Callback: {
164
+ token: StreamingCallbackToken;
165
+ callback: [Principal, string];
166
+ };
167
+ };
168
+ export interface UploadChunk {
169
+ chunk_id: bigint;
170
+ }
171
+ export interface _SERVICE {
172
+ commit_asset_upload: ActorMethod<[CommitBatch], undefined>;
173
+ del_asset: ActorMethod<[string, string], undefined>;
174
+ del_assets: ActorMethod<[[] | [string]], undefined>;
175
+ del_controllers: ActorMethod<[DeleteControllersArgs], Array<[Principal, Controller]>>;
176
+ del_custom_domain: ActorMethod<[string], undefined>;
177
+ del_doc: ActorMethod<[string, string, DelDoc], undefined>;
178
+ del_rule: ActorMethod<[RulesType, string, DelDoc], undefined>;
179
+ get_config: ActorMethod<[], Config>;
180
+ get_doc: ActorMethod<[string, string], [] | [Doc]>;
181
+ http_request: ActorMethod<[HttpRequest], HttpResponse>;
182
+ http_request_streaming_callback: ActorMethod<
183
+ [StreamingCallbackToken],
184
+ StreamingCallbackHttpResponse
185
+ >;
186
+ init_asset_upload: ActorMethod<[InitAssetKey], InitUploadResult>;
187
+ list_assets: ActorMethod<[[] | [string], ListParams], ListResults>;
188
+ list_controllers: ActorMethod<[], Array<[Principal, Controller]>>;
189
+ list_custom_domains: ActorMethod<[], Array<[string, CustomDomain]>>;
190
+ list_docs: ActorMethod<[string, ListParams], ListResults_1>;
191
+ list_rules: ActorMethod<[RulesType], Array<[string, Rule]>>;
192
+ set_config: ActorMethod<[Config], undefined>;
193
+ set_controllers: ActorMethod<[SetControllersArgs], Array<[Principal, Controller]>>;
194
+ set_custom_domain: ActorMethod<[string, [] | [string]], undefined>;
195
+ set_doc: ActorMethod<[string, string, SetDoc], Doc>;
196
+ set_rule: ActorMethod<[RulesType, string, SetRule], undefined>;
197
+ upload_asset_chunk: ActorMethod<[Chunk], UploadChunk>;
198
+ version: ActorMethod<[], string>;
199
+ }
@@ -0,0 +1,213 @@
1
+ // @ts-ignore
2
+ export const idlFactory = ({IDL}) => {
3
+ const CommitBatch = IDL.Record({
4
+ batch_id: IDL.Nat,
5
+ headers: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
6
+ chunk_ids: IDL.Vec(IDL.Nat)
7
+ });
8
+ const DeleteControllersArgs = IDL.Record({
9
+ controllers: IDL.Vec(IDL.Principal)
10
+ });
11
+ const ControllerScope = IDL.Variant({
12
+ Write: IDL.Null,
13
+ Admin: IDL.Null
14
+ });
15
+ const Controller = IDL.Record({
16
+ updated_at: IDL.Nat64,
17
+ metadata: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
18
+ created_at: IDL.Nat64,
19
+ scope: ControllerScope,
20
+ expires_at: IDL.Opt(IDL.Nat64)
21
+ });
22
+ const DelDoc = IDL.Record({updated_at: IDL.Opt(IDL.Nat64)});
23
+ const RulesType = IDL.Variant({Db: IDL.Null, Storage: IDL.Null});
24
+ const StorageConfig = IDL.Record({
25
+ headers: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text))))
26
+ });
27
+ const Config = IDL.Record({storage: StorageConfig});
28
+ const Doc = IDL.Record({
29
+ updated_at: IDL.Nat64,
30
+ owner: IDL.Principal,
31
+ data: IDL.Vec(IDL.Nat8),
32
+ description: IDL.Opt(IDL.Text),
33
+ created_at: IDL.Nat64
34
+ });
35
+ const HttpRequest = IDL.Record({
36
+ url: IDL.Text,
37
+ method: IDL.Text,
38
+ body: IDL.Vec(IDL.Nat8),
39
+ headers: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text))
40
+ });
41
+ const StreamingCallbackToken = IDL.Record({
42
+ token: IDL.Opt(IDL.Text),
43
+ sha256: IDL.Opt(IDL.Vec(IDL.Nat8)),
44
+ headers: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
45
+ index: IDL.Nat64,
46
+ encoding_type: IDL.Text,
47
+ full_path: IDL.Text
48
+ });
49
+ const StreamingStrategy = IDL.Variant({
50
+ Callback: IDL.Record({
51
+ token: StreamingCallbackToken,
52
+ callback: IDL.Func([], [], [])
53
+ })
54
+ });
55
+ const HttpResponse = IDL.Record({
56
+ body: IDL.Vec(IDL.Nat8),
57
+ headers: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
58
+ streaming_strategy: IDL.Opt(StreamingStrategy),
59
+ status_code: IDL.Nat16
60
+ });
61
+ const StreamingCallbackHttpResponse = IDL.Record({
62
+ token: IDL.Opt(StreamingCallbackToken),
63
+ body: IDL.Vec(IDL.Nat8)
64
+ });
65
+ const InitAssetKey = IDL.Record({
66
+ token: IDL.Opt(IDL.Text),
67
+ collection: IDL.Text,
68
+ name: IDL.Text,
69
+ description: IDL.Opt(IDL.Text),
70
+ encoding_type: IDL.Opt(IDL.Text),
71
+ full_path: IDL.Text
72
+ });
73
+ const InitUploadResult = IDL.Record({batch_id: IDL.Nat});
74
+ const ListOrderField = IDL.Variant({
75
+ UpdatedAt: IDL.Null,
76
+ Keys: IDL.Null,
77
+ CreatedAt: IDL.Null
78
+ });
79
+ const ListOrder = IDL.Record({field: ListOrderField, desc: IDL.Bool});
80
+ const ListMatcher = IDL.Record({
81
+ key: IDL.Opt(IDL.Text),
82
+ description: IDL.Opt(IDL.Text)
83
+ });
84
+ const ListPaginate = IDL.Record({
85
+ start_after: IDL.Opt(IDL.Text),
86
+ limit: IDL.Opt(IDL.Nat64)
87
+ });
88
+ const ListParams = IDL.Record({
89
+ order: IDL.Opt(ListOrder),
90
+ owner: IDL.Opt(IDL.Principal),
91
+ matcher: IDL.Opt(ListMatcher),
92
+ paginate: IDL.Opt(ListPaginate)
93
+ });
94
+ const AssetKey = IDL.Record({
95
+ token: IDL.Opt(IDL.Text),
96
+ collection: IDL.Text,
97
+ owner: IDL.Principal,
98
+ name: IDL.Text,
99
+ description: IDL.Opt(IDL.Text),
100
+ full_path: IDL.Text
101
+ });
102
+ const AssetEncodingNoContent = IDL.Record({
103
+ modified: IDL.Nat64,
104
+ sha256: IDL.Vec(IDL.Nat8),
105
+ total_length: IDL.Nat
106
+ });
107
+ const AssetNoContent = IDL.Record({
108
+ key: AssetKey,
109
+ updated_at: IDL.Nat64,
110
+ encodings: IDL.Vec(IDL.Tuple(IDL.Text, AssetEncodingNoContent)),
111
+ headers: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
112
+ created_at: IDL.Nat64
113
+ });
114
+ const ListResults = IDL.Record({
115
+ matches_pages: IDL.Opt(IDL.Nat64),
116
+ matches_length: IDL.Nat64,
117
+ items_page: IDL.Opt(IDL.Nat64),
118
+ items: IDL.Vec(IDL.Tuple(IDL.Text, AssetNoContent)),
119
+ items_length: IDL.Nat64
120
+ });
121
+ const CustomDomain = IDL.Record({
122
+ updated_at: IDL.Nat64,
123
+ created_at: IDL.Nat64,
124
+ bn_id: IDL.Opt(IDL.Text)
125
+ });
126
+ const ListResults_1 = IDL.Record({
127
+ matches_pages: IDL.Opt(IDL.Nat64),
128
+ matches_length: IDL.Nat64,
129
+ items_page: IDL.Opt(IDL.Nat64),
130
+ items: IDL.Vec(IDL.Tuple(IDL.Text, Doc)),
131
+ items_length: IDL.Nat64
132
+ });
133
+ const Permission = IDL.Variant({
134
+ Controllers: IDL.Null,
135
+ Private: IDL.Null,
136
+ Public: IDL.Null,
137
+ Managed: IDL.Null
138
+ });
139
+ const Rule = IDL.Record({
140
+ updated_at: IDL.Nat64,
141
+ max_size: IDL.Opt(IDL.Nat),
142
+ read: Permission,
143
+ created_at: IDL.Nat64,
144
+ write: Permission
145
+ });
146
+ const SetController = IDL.Record({
147
+ metadata: IDL.Vec(IDL.Tuple(IDL.Text, IDL.Text)),
148
+ scope: ControllerScope,
149
+ expires_at: IDL.Opt(IDL.Nat64)
150
+ });
151
+ const SetControllersArgs = IDL.Record({
152
+ controller: SetController,
153
+ controllers: IDL.Vec(IDL.Principal)
154
+ });
155
+ const SetDoc = IDL.Record({
156
+ updated_at: IDL.Opt(IDL.Nat64),
157
+ data: IDL.Vec(IDL.Nat8),
158
+ description: IDL.Opt(IDL.Text)
159
+ });
160
+ const SetRule = IDL.Record({
161
+ updated_at: IDL.Opt(IDL.Nat64),
162
+ max_size: IDL.Opt(IDL.Nat),
163
+ read: Permission,
164
+ write: Permission
165
+ });
166
+ const Chunk = IDL.Record({
167
+ content: IDL.Vec(IDL.Nat8),
168
+ batch_id: IDL.Nat
169
+ });
170
+ const UploadChunk = IDL.Record({chunk_id: IDL.Nat});
171
+ return IDL.Service({
172
+ commit_asset_upload: IDL.Func([CommitBatch], [], []),
173
+ del_asset: IDL.Func([IDL.Text, IDL.Text], [], []),
174
+ del_assets: IDL.Func([IDL.Opt(IDL.Text)], [], []),
175
+ del_controllers: IDL.Func(
176
+ [DeleteControllersArgs],
177
+ [IDL.Vec(IDL.Tuple(IDL.Principal, Controller))],
178
+ []
179
+ ),
180
+ del_custom_domain: IDL.Func([IDL.Text], [], []),
181
+ del_doc: IDL.Func([IDL.Text, IDL.Text, DelDoc], [], []),
182
+ del_rule: IDL.Func([RulesType, IDL.Text, DelDoc], [], []),
183
+ get_config: IDL.Func([], [Config], []),
184
+ get_doc: IDL.Func([IDL.Text, IDL.Text], [IDL.Opt(Doc)], ['query']),
185
+ http_request: IDL.Func([HttpRequest], [HttpResponse], ['query']),
186
+ http_request_streaming_callback: IDL.Func(
187
+ [StreamingCallbackToken],
188
+ [StreamingCallbackHttpResponse],
189
+ ['query']
190
+ ),
191
+ init_asset_upload: IDL.Func([InitAssetKey], [InitUploadResult], []),
192
+ list_assets: IDL.Func([IDL.Opt(IDL.Text), ListParams], [ListResults], ['query']),
193
+ list_controllers: IDL.Func([], [IDL.Vec(IDL.Tuple(IDL.Principal, Controller))], ['query']),
194
+ list_custom_domains: IDL.Func([], [IDL.Vec(IDL.Tuple(IDL.Text, CustomDomain))], ['query']),
195
+ list_docs: IDL.Func([IDL.Text, ListParams], [ListResults_1], ['query']),
196
+ list_rules: IDL.Func([RulesType], [IDL.Vec(IDL.Tuple(IDL.Text, Rule))], ['query']),
197
+ set_config: IDL.Func([Config], [], []),
198
+ set_controllers: IDL.Func(
199
+ [SetControllersArgs],
200
+ [IDL.Vec(IDL.Tuple(IDL.Principal, Controller))],
201
+ []
202
+ ),
203
+ set_custom_domain: IDL.Func([IDL.Text, IDL.Opt(IDL.Text)], [], []),
204
+ set_doc: IDL.Func([IDL.Text, IDL.Text, SetDoc], [Doc], []),
205
+ set_rule: IDL.Func([RulesType, IDL.Text, SetRule], [], []),
206
+ upload_asset_chunk: IDL.Func([Chunk], [UploadChunk], []),
207
+ version: IDL.Func([], [IDL.Text], ['query'])
208
+ });
209
+ };
210
+ // @ts-ignore
211
+ export const init = ({IDL}) => {
212
+ return [];
213
+ };
@@ -0,0 +1,45 @@
1
+ import type {ActorConfig, ActorSubclass, Agent, HttpAgentOptions} from '@dfinity/agent';
2
+ import type {IDL} from '@dfinity/candid';
3
+ import type {Principal} from '@dfinity/principal';
4
+
5
+ import {_SERVICE} from './satellite.did';
6
+
7
+ export declare const idlFactory: IDL.InterfaceFactory;
8
+ export declare const canisterId: string;
9
+
10
+ export declare interface CreateActorOptions {
11
+ /**
12
+ * @see {@link Agent}
13
+ */
14
+ agent?: Agent;
15
+ /**
16
+ * @see {@link HttpAgentOptions}
17
+ */
18
+ agentOptions?: HttpAgentOptions;
19
+ /**
20
+ * @see {@link ActorConfig}
21
+ */
22
+ actorOptions?: ActorConfig;
23
+ }
24
+
25
+ /**
26
+ * Intializes an {@link ActorSubclass}, configured with the provided SERVICE interface of a canister.
27
+ * @constructs {@link ActorSubClass}
28
+ * @param {string | Principal} canisterId - ID of the canister the {@link Actor} will talk to
29
+ * @param {CreateActorOptions} options - see {@link CreateActorOptions}
30
+ * @param {CreateActorOptions["agent"]} options.agent - a pre-configured agent you'd like to use. Supercedes agentOptions
31
+ * @param {CreateActorOptions["agentOptions"]} options.agentOptions - options to set up a new agent
32
+ * @see {@link HttpAgentOptions}
33
+ * @param {CreateActorOptions["actorOptions"]} options.actorOptions - options for the Actor
34
+ * @see {@link ActorConfig}
35
+ */
36
+ export declare const createActor: (
37
+ canisterId: string | Principal,
38
+ options?: CreateActorOptions
39
+ ) => ActorSubclass<_SERVICE>;
40
+
41
+ /**
42
+ * Intialized Actor using default settings, ready to talk to a canister using its candid interface
43
+ * @constructs {@link ActorSubClass}
44
+ */
45
+ export declare const satellite: ActorSubclass<_SERVICE>;
@@ -0,0 +1,37 @@
1
+ import {Actor, HttpAgent} from '@dfinity/agent';
2
+
3
+ // Imports and re-exports candid interface
4
+ import {idlFactory} from './satellite.did.js';
5
+ export {idlFactory} from './satellite.did.js';
6
+
7
+ /* CANISTER_ID is replaced by webpack based on node environment
8
+ * Note: canister environment variable will be standardized as
9
+ * process.env.CANISTER_ID_<CANISTER_NAME_UPPERCASE>
10
+ * beginning in dfx 0.15.0
11
+ */
12
+ export const canisterId = process.env.CANISTER_ID_SATELLITE || process.env.SATELLITE_CANISTER_ID;
13
+
14
+ export const createActor = (canisterId, options = {}) => {
15
+ const agent = options.agent || new HttpAgent({...options.agentOptions});
16
+
17
+ if (options.agent && options.agentOptions) {
18
+ console.warn(
19
+ 'Detected both agent and agentOptions passed to createActor. Ignoring agentOptions and proceeding with the provided agent.'
20
+ );
21
+ }
22
+
23
+ // Fetch root key for certificate validation during development
24
+ if (process.env.DFX_NETWORK !== 'ic') {
25
+ agent.fetchRootKey().catch((err) => {
26
+ console.warn('Unable to fetch root key. Check to ensure that your local replica is running');
27
+ console.error(err);
28
+ });
29
+ }
30
+
31
+ // Creates an actor with using the candid interface and the HttpAgent
32
+ return Actor.createActor(idlFactory, {
33
+ agent,
34
+ canisterId,
35
+ ...options.actorOptions
36
+ });
37
+ };
@@ -0,0 +1,207 @@
1
+ import type {ActorMethod} from '@dfinity/agent';
2
+ import type {Principal} from '@dfinity/principal';
3
+
4
+ export interface AssetEncodingNoContent {
5
+ modified: bigint;
6
+ sha256: Uint8Array | number[];
7
+ total_length: bigint;
8
+ }
9
+ export interface AssetKey {
10
+ token: [] | [string];
11
+ collection: string;
12
+ owner: Principal;
13
+ name: string;
14
+ description: [] | [string];
15
+ full_path: string;
16
+ }
17
+ export interface AssetNoContent {
18
+ key: AssetKey;
19
+ updated_at: bigint;
20
+ encodings: Array<[string, AssetEncodingNoContent]>;
21
+ headers: Array<[string, string]>;
22
+ created_at: bigint;
23
+ }
24
+ export interface CommitBatch {
25
+ batch_id: bigint;
26
+ headers: Array<[string, string]>;
27
+ chunk_ids: Array<bigint>;
28
+ }
29
+ export interface Config {
30
+ storage: StorageConfig;
31
+ }
32
+ export interface Controller {
33
+ updated_at: bigint;
34
+ metadata: Array<[string, string]>;
35
+ created_at: bigint;
36
+ scope: ControllerScope;
37
+ expires_at: [] | [bigint];
38
+ }
39
+ export type ControllerScope = {Write: null} | {Admin: null};
40
+ export interface CustomDomain {
41
+ updated_at: bigint;
42
+ created_at: bigint;
43
+ bn_id: [] | [string];
44
+ }
45
+ export interface DelDoc {
46
+ updated_at: [] | [bigint];
47
+ }
48
+ export interface DeleteControllersArgs {
49
+ controllers: Array<Principal>;
50
+ }
51
+ export interface Doc {
52
+ updated_at: bigint;
53
+ owner: Principal;
54
+ data: Uint8Array | number[];
55
+ description: [] | [string];
56
+ created_at: bigint;
57
+ }
58
+ export interface HttpRequest {
59
+ url: string;
60
+ method: string;
61
+ body: Uint8Array | number[];
62
+ headers: Array<[string, string]>;
63
+ }
64
+ export interface HttpResponse {
65
+ body: Uint8Array | number[];
66
+ headers: Array<[string, string]>;
67
+ streaming_strategy: [] | [StreamingStrategy];
68
+ status_code: number;
69
+ }
70
+ export interface InitAssetKey {
71
+ token: [] | [string];
72
+ collection: string;
73
+ name: string;
74
+ description: [] | [string];
75
+ encoding_type: [] | [string];
76
+ full_path: string;
77
+ }
78
+ export interface InitUploadResult {
79
+ batch_id: bigint;
80
+ }
81
+ export interface ListMatcher {
82
+ key: [] | [string];
83
+ description: [] | [string];
84
+ }
85
+ export interface ListOrder {
86
+ field: ListOrderField;
87
+ desc: boolean;
88
+ }
89
+ export type ListOrderField = {UpdatedAt: null} | {Keys: null} | {CreatedAt: null};
90
+ export interface ListPaginate {
91
+ start_after: [] | [string];
92
+ limit: [] | [bigint];
93
+ }
94
+ export interface ListParams {
95
+ order: [] | [ListOrder];
96
+ owner: [] | [Principal];
97
+ matcher: [] | [ListMatcher];
98
+ paginate: [] | [ListPaginate];
99
+ }
100
+ export interface ListResults {
101
+ matches_pages: [] | [bigint];
102
+ matches_length: bigint;
103
+ items_page: [] | [bigint];
104
+ items: Array<[string, AssetNoContent]>;
105
+ items_length: bigint;
106
+ }
107
+ export interface ListResults_1 {
108
+ matches_pages: [] | [bigint];
109
+ matches_length: bigint;
110
+ items_page: [] | [bigint];
111
+ items: Array<[string, Doc]>;
112
+ items_length: bigint;
113
+ }
114
+ export type Memory = {Heap: null} | {Stable: null};
115
+ export type Permission = {Controllers: null} | {Private: null} | {Public: null} | {Managed: null};
116
+ export interface Rule {
117
+ memory: [] | [Memory];
118
+ updated_at: bigint;
119
+ max_size: [] | [bigint];
120
+ read: Permission;
121
+ created_at: bigint;
122
+ mutable_permissions: [] | [boolean];
123
+ write: Permission;
124
+ }
125
+ export type RulesType = {Db: null} | {Storage: null};
126
+ export interface SetController {
127
+ metadata: Array<[string, string]>;
128
+ scope: ControllerScope;
129
+ expires_at: [] | [bigint];
130
+ }
131
+ export interface SetControllersArgs {
132
+ controller: SetController;
133
+ controllers: Array<Principal>;
134
+ }
135
+ export interface SetDoc {
136
+ updated_at: [] | [bigint];
137
+ data: Uint8Array | number[];
138
+ description: [] | [string];
139
+ }
140
+ export interface SetRule {
141
+ memory: [] | [Memory];
142
+ updated_at: [] | [bigint];
143
+ max_size: [] | [bigint];
144
+ read: Permission;
145
+ mutable_permissions: [] | [boolean];
146
+ write: Permission;
147
+ }
148
+ export interface StorageConfig {
149
+ rewrites: Array<[string, string]>;
150
+ headers: Array<[string, Array<[string, string]>]>;
151
+ }
152
+ export interface StreamingCallbackHttpResponse {
153
+ token: [] | [StreamingCallbackToken];
154
+ body: Uint8Array | number[];
155
+ }
156
+ export interface StreamingCallbackToken {
157
+ memory: Memory;
158
+ token: [] | [string];
159
+ sha256: [] | [Uint8Array | number[]];
160
+ headers: Array<[string, string]>;
161
+ index: bigint;
162
+ encoding_type: string;
163
+ full_path: string;
164
+ }
165
+ export type StreamingStrategy = {
166
+ Callback: {
167
+ token: StreamingCallbackToken;
168
+ callback: [Principal, string];
169
+ };
170
+ };
171
+ export interface UploadChunk {
172
+ content: Uint8Array | number[];
173
+ batch_id: bigint;
174
+ order_id: [] | [bigint];
175
+ }
176
+ export interface UploadChunkResult {
177
+ chunk_id: bigint;
178
+ }
179
+ export interface _SERVICE {
180
+ commit_asset_upload: ActorMethod<[CommitBatch], undefined>;
181
+ del_asset: ActorMethod<[string, string], undefined>;
182
+ del_assets: ActorMethod<[string], undefined>;
183
+ del_controllers: ActorMethod<[DeleteControllersArgs], Array<[Principal, Controller]>>;
184
+ del_custom_domain: ActorMethod<[string], undefined>;
185
+ del_doc: ActorMethod<[string, string, DelDoc], undefined>;
186
+ del_rule: ActorMethod<[RulesType, string, DelDoc], undefined>;
187
+ get_config: ActorMethod<[], Config>;
188
+ get_doc: ActorMethod<[string, string], [] | [Doc]>;
189
+ http_request: ActorMethod<[HttpRequest], HttpResponse>;
190
+ http_request_streaming_callback: ActorMethod<
191
+ [StreamingCallbackToken],
192
+ StreamingCallbackHttpResponse
193
+ >;
194
+ init_asset_upload: ActorMethod<[InitAssetKey], InitUploadResult>;
195
+ list_assets: ActorMethod<[string, ListParams], ListResults>;
196
+ list_controllers: ActorMethod<[], Array<[Principal, Controller]>>;
197
+ list_custom_domains: ActorMethod<[], Array<[string, CustomDomain]>>;
198
+ list_docs: ActorMethod<[string, ListParams], ListResults_1>;
199
+ list_rules: ActorMethod<[RulesType], Array<[string, Rule]>>;
200
+ set_config: ActorMethod<[Config], undefined>;
201
+ set_controllers: ActorMethod<[SetControllersArgs], Array<[Principal, Controller]>>;
202
+ set_custom_domain: ActorMethod<[string, [] | [string]], undefined>;
203
+ set_doc: ActorMethod<[string, string, SetDoc], Doc>;
204
+ set_rule: ActorMethod<[RulesType, string, SetRule], undefined>;
205
+ upload_asset_chunk: ActorMethod<[UploadChunk], UploadChunkResult>;
206
+ version: ActorMethod<[], string>;
207
+ }