@junobuild/functions 0.8.2 → 0.8.3-next-2026-04-11
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.
- package/README.md +4 -4
- package/ic-cdk/schemas/http-request.d.ts +3 -3
- package/ic-cdk.js +1 -1
- package/ic-cdk.js.map +3 -3
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -2386,9 +2386,9 @@ References:
|
|
|
2386
2386
|
|
|
2387
2387
|
#### :gear: HttpRequestArgsSchema
|
|
2388
2388
|
|
|
2389
|
-
| Constant | Type
|
|
2390
|
-
| ----------------------- |
|
|
2391
|
-
| `HttpRequestArgsSchema` | `ZodObject<{ url: ZodURL; method: ZodEnum<{ GET: "GET"; POST: "POST"; HEAD: "HEAD"; }>; headers: ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, $strip
|
|
2389
|
+
| Constant | Type |
|
|
2390
|
+
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
2391
|
+
| `HttpRequestArgsSchema` | `ZodObject<{ url: ZodURL; method: ZodEnum<{ GET: "GET"; POST: "POST"; HEAD: "HEAD"; }>; headers: ZodOptional<ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, $strip>>>; body: ZodOptional<...>; maxResponseBytes: ZodOptional<...>; transform: ZodOptional<...>; isReplicated: ZodOptional<...>; }, $strip>` |
|
|
2392
2392
|
|
|
2393
2393
|
References:
|
|
2394
2394
|
|
|
@@ -2852,7 +2852,7 @@ The arguments for an HTTP request.
|
|
|
2852
2852
|
| ------------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
2853
2853
|
| `url` | `string` | The requested URL. |
|
|
2854
2854
|
| `method` | `HttpMethod` | The HTTP method. |
|
|
2855
|
-
| `headers` | `HttpHeader[]`
|
|
2855
|
+
| `headers` | `HttpHeader[] or undefined` | List of HTTP request headers and their corresponding values. |
|
|
2856
2856
|
| `body` | `Uint8Array<ArrayBuffer> or undefined` | Optionally provide request body. |
|
|
2857
2857
|
| `maxResponseBytes` | `bigint or undefined` | The maximal size of the response in bytes. |
|
|
2858
2858
|
| `transform` | `string or undefined` | The name of a query function used to transform the response before consensus - for example, to trim headers. If provided, a corresponding query must be declared using {@link defineQuery }. |
|
|
@@ -23,10 +23,10 @@ export declare const HttpRequestArgsSchema: import("zod").ZodObject<{
|
|
|
23
23
|
POST: "POST";
|
|
24
24
|
HEAD: "HEAD";
|
|
25
25
|
}>;
|
|
26
|
-
headers: import("zod").ZodArray<import("zod").ZodObject<{
|
|
26
|
+
headers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
27
27
|
name: import("zod").ZodString;
|
|
28
28
|
value: import("zod").ZodString;
|
|
29
|
-
}, import("zod/v4/core").$strip
|
|
29
|
+
}, import("zod/v4/core").$strip>>>;
|
|
30
30
|
body: import("zod").ZodOptional<import("zod").ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>>;
|
|
31
31
|
maxResponseBytes: import("zod").ZodOptional<import("zod").ZodBigInt>;
|
|
32
32
|
transform: import("zod").ZodOptional<import("zod").ZodString>;
|
|
@@ -89,7 +89,7 @@ export interface HttpRequestArgs {
|
|
|
89
89
|
/**
|
|
90
90
|
* List of HTTP request headers and their corresponding values.
|
|
91
91
|
*/
|
|
92
|
-
headers
|
|
92
|
+
headers?: HttpHeader[];
|
|
93
93
|
/**
|
|
94
94
|
* Optionally provide request body.
|
|
95
95
|
*/
|
package/ic-cdk.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{a as
|
|
1
|
+
import{a as y,b as R,c as h,d as A,e as g,f as _,g as b}from"./chunk-YHNBR22R.js";import"./chunk-JU5CZHLY.js";import"./chunk-4C666HHU.js";import{Principal as m}from"@icp-sdk/core/principal";var u=()=>m.fromUint8Array(__ic_cdk_caller()),S=()=>u();import{convertCamelToSnake as x,nonNullish as d}from"@junobuild/utils";import{j as t}from"@junobuild/schema";var s=t.object({name:t.string(),value:t.string()}),f=t.enum(["GET","POST","HEAD"]),a=t.object({url:t.url(),method:f,headers:t.array(s).optional(),body:t.uint8Array().optional(),maxResponseBytes:t.bigint().optional(),transform:t.string().optional(),isReplicated:t.boolean().optional()}),r=t.object({status:t.nat(),headers:t.array(s),body:t.uint8Array()}),j=t.object({response:r,context:t.uint8Array()});var E=async e=>{a.parse(e);let{transform:o,headers:p,...i}=e,c={...i,headers:p??[],...d(o)&&{transform:`app_${x(o)}`}},l=await __ic_cdk_http_request(c);return r.parse(l)};import{Principal as H}from"@icp-sdk/core/principal";var n=()=>H.fromUint8Array(__ic_cdk_id()),C=()=>n(),D=()=>n();var O=()=>__ic_cdk_time();export{R as CallArgSchema,h as CallArgsSchema,g as CallParamsSchema,_ as CallResponseLengthError,A as CallResultSchema,s as HttpHeaderSchema,f as HttpMethodSchema,a as HttpRequestArgsSchema,r as HttpRequestResultSchema,y as IDLTypeSchema,j as TransformArgsSchema,b as call,S as caller,n as canisterSelf,E as httpRequest,C as id,u as msgCaller,D as satelliteSelf,O as time};
|
|
2
2
|
//# sourceMappingURL=ic-cdk.js.map
|
package/ic-cdk.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["src/ic-cdk/caller.ic-cdk.ts", "src/ic-cdk/http-request.ic-cdk.ts", "src/ic-cdk/schemas/http-request.ts", "src/ic-cdk/id.ic-cdk.ts", "src/ic-cdk/time.ic-cdk.ts"],
|
|
4
|
-
"sourcesContent": ["import {Principal} from '@icp-sdk/core/principal';\n\n/**\n * Retrieves the caller's Principal ID.\n *\n * This function is a JavaScript binding for the Rust function\n * [`ic_cdk::api::msg_caller()`](https://docs.rs/ic-cdk/latest/ic_cdk/api/fn.msg_caller.html), which returns\n * the Principal of the caller of the current call.\n *\n * @returns {Principal} The Principal ID of the caller.\n */\nexport const msgCaller = (): Principal => {\n const principal = Principal.fromUint8Array(__ic_cdk_caller());\n\n return principal;\n};\n\n/**\n * @deprecated Use {@link msgCaller} instead.\n */\nexport const caller = (): Principal => msgCaller();\n", "import {convertCamelToSnake, nonNullish} from '@junobuild/utils';\nimport {\n type HttpRequestArgs,\n type HttpRequestResult,\n HttpRequestArgsSchema,\n HttpRequestResultSchema\n} from './schemas/http-request';\n\n/**\n * Performs an HTTP request from a Juno serverless function.\n *\n * @param {HttpRequestArgs} args - The HTTP request parameters\n * @returns {Promise<HttpRequestResult>} A promise resolving to the HTTP response.\n * @throws {ZodError} If the provided arguments do not match the expected schema.\n * @throws {Error} If the HTTP request fails.\n */\nexport const httpRequest = async (args: HttpRequestArgs): Promise<HttpRequestResult> => {\n HttpRequestArgsSchema.parse(args);\n\n const {transform, ...rest} = args;\n\n const normalizedArgs = {\n ...rest,\n // TODO: app_ duplicates functions-tools BACKEND_FUNCTION_NAMESPACE constants\n ...(nonNullish(transform) && {transform: `app_${convertCamelToSnake(transform)}`})\n };\n\n const result = await __ic_cdk_http_request(normalizedArgs);\n\n return HttpRequestResultSchema.parse(result);\n};\n", "import {j} from '@junobuild/schema';\n\n/**\n * @see HttpHeader\n */\nexport const HttpHeaderSchema = j.object({\n name: j.string(),\n value: j.string()\n});\n\n/**\n * @see HttpMethod\n */\nexport const HttpMethodSchema = j.enum(['GET', 'POST', 'HEAD']);\n\n/**\n * @see HttpRequestArgs\n */\nexport const HttpRequestArgsSchema = j.object({\n url: j.url(),\n method: HttpMethodSchema,\n headers: j.array(HttpHeaderSchema),\n body: j.uint8Array().optional(),\n maxResponseBytes: j.bigint().optional(),\n transform: j.string().optional(),\n isReplicated: j.boolean().optional()\n});\n\n/**\n * @see HttpRequestResult\n */\nexport const HttpRequestResultSchema = j.object({\n status: j.nat(),\n headers: j.array(HttpHeaderSchema),\n body: j.uint8Array()\n});\n\n/**\n * @see TransformArgs\n */\nexport const TransformArgsSchema = j.object({\n response: HttpRequestResultSchema,\n context: j.uint8Array()\n});\n\n/**\n * An HTTP header consisting of a name and value.\n */\nexport interface HttpHeader {\n /**\n * The header name.\n */\n name: string;\n\n /**\n * The header value.\n */\n value: string;\n}\n\n/**\n * The HTTP method for the request.\n */\nexport type HttpMethod = 'GET' | 'POST' | 'HEAD';\n\n/**\n * The arguments for an HTTP request.\n */\nexport interface HttpRequestArgs {\n /**\n * The requested URL.\n */\n url: string;\n\n /**\n * The HTTP method.\n */\n method: HttpMethod;\n\n /**\n * List of HTTP request headers and their corresponding values.\n */\n headers
|
|
5
|
-
"mappings": "0IAAA,OAAQ,aAAAA,MAAgB,0BAWjB,IAAMC,EAAY,IACLD,EAAU,eAAe,gBAAgB,CAAC,EAQjDE,EAAS,IAAiBD,EAAU,ECpBjD,OAAQ,uBAAAE,EAAqB,cAAAC,MAAiB,mBCA9C,OAAQ,KAAAC,MAAQ,oBAKT,IAAMC,EAAmBD,EAAE,OAAO,CACvC,KAAMA,EAAE,OAAO,EACf,MAAOA,EAAE,OAAO,CAClB,CAAC,EAKYE,EAAmBF,EAAE,KAAK,CAAC,MAAO,OAAQ,MAAM,CAAC,EAKjDG,EAAwBH,EAAE,OAAO,CAC5C,IAAKA,EAAE,IAAI,EACX,OAAQE,EACR,QAASF,EAAE,MAAMC,CAAgB,
|
|
6
|
-
"names": ["Principal", "msgCaller", "caller", "convertCamelToSnake", "nonNullish", "j", "HttpHeaderSchema", "HttpMethodSchema", "HttpRequestArgsSchema", "HttpRequestResultSchema", "TransformArgsSchema", "httpRequest", "args", "HttpRequestArgsSchema", "transform", "rest", "normalizedArgs", "nonNullish", "convertCamelToSnake", "result", "HttpRequestResultSchema", "Principal", "canisterSelf", "id", "satelliteSelf", "time"]
|
|
4
|
+
"sourcesContent": ["import {Principal} from '@icp-sdk/core/principal';\n\n/**\n * Retrieves the caller's Principal ID.\n *\n * This function is a JavaScript binding for the Rust function\n * [`ic_cdk::api::msg_caller()`](https://docs.rs/ic-cdk/latest/ic_cdk/api/fn.msg_caller.html), which returns\n * the Principal of the caller of the current call.\n *\n * @returns {Principal} The Principal ID of the caller.\n */\nexport const msgCaller = (): Principal => {\n const principal = Principal.fromUint8Array(__ic_cdk_caller());\n\n return principal;\n};\n\n/**\n * @deprecated Use {@link msgCaller} instead.\n */\nexport const caller = (): Principal => msgCaller();\n", "import {convertCamelToSnake, nonNullish} from '@junobuild/utils';\nimport {\n type HttpRequestArgs,\n type HttpRequestResult,\n HttpRequestArgsSchema,\n HttpRequestResultSchema\n} from './schemas/http-request';\n\n/**\n * Performs an HTTP request from a Juno serverless function.\n *\n * @param {HttpRequestArgs} args - The HTTP request parameters\n * @returns {Promise<HttpRequestResult>} A promise resolving to the HTTP response.\n * @throws {ZodError} If the provided arguments do not match the expected schema.\n * @throws {Error} If the HTTP request fails.\n */\nexport const httpRequest = async (args: HttpRequestArgs): Promise<HttpRequestResult> => {\n HttpRequestArgsSchema.parse(args);\n\n const {transform, headers, ...rest} = args;\n\n const normalizedArgs = {\n ...rest,\n headers: headers ?? [],\n // TODO: app_ duplicates functions-tools BACKEND_FUNCTION_NAMESPACE constants\n ...(nonNullish(transform) && {transform: `app_${convertCamelToSnake(transform)}`})\n };\n\n const result = await __ic_cdk_http_request(normalizedArgs);\n\n return HttpRequestResultSchema.parse(result);\n};\n", "import {j} from '@junobuild/schema';\n\n/**\n * @see HttpHeader\n */\nexport const HttpHeaderSchema = j.object({\n name: j.string(),\n value: j.string()\n});\n\n/**\n * @see HttpMethod\n */\nexport const HttpMethodSchema = j.enum(['GET', 'POST', 'HEAD']);\n\n/**\n * @see HttpRequestArgs\n */\nexport const HttpRequestArgsSchema = j.object({\n url: j.url(),\n method: HttpMethodSchema,\n headers: j.array(HttpHeaderSchema).optional(),\n body: j.uint8Array().optional(),\n maxResponseBytes: j.bigint().optional(),\n transform: j.string().optional(),\n isReplicated: j.boolean().optional()\n});\n\n/**\n * @see HttpRequestResult\n */\nexport const HttpRequestResultSchema = j.object({\n status: j.nat(),\n headers: j.array(HttpHeaderSchema),\n body: j.uint8Array()\n});\n\n/**\n * @see TransformArgs\n */\nexport const TransformArgsSchema = j.object({\n response: HttpRequestResultSchema,\n context: j.uint8Array()\n});\n\n/**\n * An HTTP header consisting of a name and value.\n */\nexport interface HttpHeader {\n /**\n * The header name.\n */\n name: string;\n\n /**\n * The header value.\n */\n value: string;\n}\n\n/**\n * The HTTP method for the request.\n */\nexport type HttpMethod = 'GET' | 'POST' | 'HEAD';\n\n/**\n * The arguments for an HTTP request.\n */\nexport interface HttpRequestArgs {\n /**\n * The requested URL.\n */\n url: string;\n\n /**\n * The HTTP method.\n */\n method: HttpMethod;\n\n /**\n * List of HTTP request headers and their corresponding values.\n */\n headers?: HttpHeader[];\n\n /**\n * Optionally provide request body.\n */\n body?: Uint8Array<ArrayBuffer>;\n\n /**\n * The maximal size of the response in bytes.\n */\n maxResponseBytes?: bigint;\n\n /**\n * The name of a query function used to transform the response before consensus - for example, to trim headers.\n * If provided, a corresponding query must be declared using {@link defineQuery}.\n */\n transform?: string;\n\n /**\n * Whether all nodes should perform the request and agree on the response, or just one node.\n * Using a single node is cheaper but the response is not verified by others - suitable when you trust the data source or consistency is not critical.\n * Defaults to all nodes if not specified.\n */\n isReplicated?: boolean;\n}\n\n/**\n * The result of an HTTP request.\n */\nexport interface HttpRequestResult {\n /**\n * The response status (e.g. 200, 404).\n */\n status: bigint;\n\n /**\n * List of HTTP response headers and their corresponding values.\n */\n headers: HttpHeader[];\n\n /**\n * The response's body.\n */\n body: Uint8Array<ArrayBuffer>;\n}\n\n/**\n * The arguments passed to an HTTP response transform function.\n */\nexport interface TransformArgs {\n /**\n * The raw HTTP response to be transformed.\n */\n response: HttpRequestResult;\n\n /**\n * Context for response transformation\n */\n context: Uint8Array<ArrayBuffer>;\n}\n", "import {Principal} from '@icp-sdk/core/principal';\n\n/**\n * Retrieves the Satellite's Principal ID.\n *\n * This function is a JavaScript binding for the Rust function\n * [`ic_cdk::api::canister_self()`](https://docs.rs/ic-cdk/latest/ic_cdk/api/fn.canister_self.html), which returns\n * the Principal of the executing canister.\n *\n * @returns {Principal} The Principal ID of the Satellite.\n */\nexport const canisterSelf = (): Principal => {\n const principal = Principal.fromUint8Array(__ic_cdk_id());\n\n // We assume the Principal is always built using the global function and is therefore always valid.\n // In other words, we do not validate it to conserve resources and optimize performance.\n\n return principal;\n};\n\n/**\n * @deprecated Use {@link canisterSelf} instead.\n */\nexport const id = (): Principal => canisterSelf();\n\n/**\n * Retrieves the Satellite's Principal ID.\n *\n * @returns {Principal} The Principal ID of the Satellite.\n */\nexport const satelliteSelf = (): Principal => canisterSelf();\n", "/**\n * Gets current timestamp, in nanoseconds since the epoch (1970-01-01)\n *\n * This function is a JavaScript binding for the Rust function\n * [`ic_cdk::time()`](https://docs.rs/ic-cdk/latest/ic_cdk/api/fn.time.html), which returns\n * the system time publicly exposed and verified part of the IC state tree\n *\n * @returns {bigint} The current timestamp.\n */\nexport const time = (): bigint => __ic_cdk_time();\n"],
|
|
5
|
+
"mappings": "0IAAA,OAAQ,aAAAA,MAAgB,0BAWjB,IAAMC,EAAY,IACLD,EAAU,eAAe,gBAAgB,CAAC,EAQjDE,EAAS,IAAiBD,EAAU,ECpBjD,OAAQ,uBAAAE,EAAqB,cAAAC,MAAiB,mBCA9C,OAAQ,KAAAC,MAAQ,oBAKT,IAAMC,EAAmBD,EAAE,OAAO,CACvC,KAAMA,EAAE,OAAO,EACf,MAAOA,EAAE,OAAO,CAClB,CAAC,EAKYE,EAAmBF,EAAE,KAAK,CAAC,MAAO,OAAQ,MAAM,CAAC,EAKjDG,EAAwBH,EAAE,OAAO,CAC5C,IAAKA,EAAE,IAAI,EACX,OAAQE,EACR,QAASF,EAAE,MAAMC,CAAgB,EAAE,SAAS,EAC5C,KAAMD,EAAE,WAAW,EAAE,SAAS,EAC9B,iBAAkBA,EAAE,OAAO,EAAE,SAAS,EACtC,UAAWA,EAAE,OAAO,EAAE,SAAS,EAC/B,aAAcA,EAAE,QAAQ,EAAE,SAAS,CACrC,CAAC,EAKYI,EAA0BJ,EAAE,OAAO,CAC9C,OAAQA,EAAE,IAAI,EACd,QAASA,EAAE,MAAMC,CAAgB,EACjC,KAAMD,EAAE,WAAW,CACrB,CAAC,EAKYK,EAAsBL,EAAE,OAAO,CAC1C,SAAUI,EACV,QAASJ,EAAE,WAAW,CACxB,CAAC,ED3BM,IAAMM,EAAc,MAAOC,GAAsD,CACtFC,EAAsB,MAAMD,CAAI,EAEhC,GAAM,CAAC,UAAAE,EAAW,QAAAC,EAAS,GAAGC,CAAI,EAAIJ,EAEhCK,EAAiB,CACrB,GAAGD,EACH,QAASD,GAAW,CAAC,EAErB,GAAIG,EAAWJ,CAAS,GAAK,CAAC,UAAW,OAAOK,EAAoBL,CAAS,CAAC,EAAE,CAClF,EAEMM,EAAS,MAAM,sBAAsBH,CAAc,EAEzD,OAAOI,EAAwB,MAAMD,CAAM,CAC7C,EE/BA,OAAQ,aAAAE,MAAgB,0BAWjB,IAAMC,EAAe,IACRD,EAAU,eAAe,YAAY,CAAC,EAW7CE,EAAK,IAAiBD,EAAa,EAOnCE,EAAgB,IAAiBF,EAAa,ECrBpD,IAAMG,EAAO,IAAc,cAAc",
|
|
6
|
+
"names": ["Principal", "msgCaller", "caller", "convertCamelToSnake", "nonNullish", "j", "HttpHeaderSchema", "HttpMethodSchema", "HttpRequestArgsSchema", "HttpRequestResultSchema", "TransformArgsSchema", "httpRequest", "args", "HttpRequestArgsSchema", "transform", "headers", "rest", "normalizedArgs", "nonNullish", "convertCamelToSnake", "result", "HttpRequestResultSchema", "Principal", "canisterSelf", "id", "satelliteSelf", "time"]
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@junobuild/functions",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.3-next-2026-04-11",
|
|
4
4
|
"description": "JavaScript and TypeScript utilities for Juno Serverless Functions",
|
|
5
5
|
"author": "David Dal Busco (https://daviddalbusco.com)",
|
|
6
6
|
"license": "MIT",
|
|
@@ -94,9 +94,9 @@
|
|
|
94
94
|
],
|
|
95
95
|
"homepage": "https://juno.build",
|
|
96
96
|
"peerDependencies": {
|
|
97
|
-
"@icp-sdk/core": "
|
|
98
|
-
"@junobuild/schema": "
|
|
99
|
-
"@junobuild/utils": "
|
|
100
|
-
"zod": "
|
|
97
|
+
"@icp-sdk/core": "*",
|
|
98
|
+
"@junobuild/schema": "*",
|
|
99
|
+
"@junobuild/utils": "*",
|
|
100
|
+
"zod": "*"
|
|
101
101
|
}
|
|
102
|
-
}
|
|
102
|
+
}
|