starred/windmill
1
0
Fork 0
mirror of https://github.com/windmill-labs/windmill.git synced 2026-08-21 00:02:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(deno-client): improve docs by extending function signatures (#791)

Browse Source 
> as a windmill script developer I want to know what type/data structure is returned from the windmill sdk
This commit is contained in:
Jakub Kołodziejczak
2022-10-22 14:04:38 +02:00
committed by GitHub
parent a9359dada7
commit 759425bbac
1 changed files with 25 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
deno-client/mod.ts
+25 -5
View File
@@ -138,7 +138,18 @@ export async function databaseUrlFromResource(path: string): Promise<string> {
}
export async function genNounceAndHmac(workspace: string, jobId: string) {
export interface NonceAndHmac {
nonce: number;
signature: string;
}
/**
* Get HMAC and nonce needed for approval script
* @param workspace workspace name
* @param jobId
* @returns HMAC and nonce needed to authorize approval script actions
*/
export async function genNounceAndHmac(workspace: string, jobId: string): Promise<NonceAndHmac> {
const nonce = Math.floor(Math.random() * 4294967295);
const sig = await fetch(Deno.env.get("WM_BASE_URL") +
`/api/w/${workspace}/jobs/job_signature/${jobId}/${nonce}?token=${Deno.env.get("WM_TOKEN")}`)
@@ -148,7 +159,17 @@ export async function genNounceAndHmac(workspace: string, jobId: string) {
};
}
export async function getResumeEndpoints() {
export interface ResumeEndpoints {
approvalPage: string;
resume: string;
cancel: string;
}
/**
* Get URLs needed for approval script
* @returns approval page UI URL, resume and cancel API URLs for approval script
*/
export async function getResumeEndpoints(): Promise<ResumeEndpoints> {
const workspace = getWorkspace()
const { nonce, signature } = await genNounceAndHmac(
@@ -158,7 +179,7 @@ export async function getResumeEndpoints() {
const url_prefix = Deno.env.get("WM_BASE_URL") +
`/api/w/${workspace}/jobs/`;
function getResumeUrl(op: string) {
function getResumeUrl(op: string): string {
return url_prefix +
`${op}/${Deno.env.get("WM_JOB_ID")}/${nonce}/${signature}`;
}
@@ -170,7 +191,6 @@ export async function getResumeEndpoints() {
};
}
export function base64ToUint8Array(data: string): Uint8Array {
return Uint8Array.from(atob(data), c => c.charCodeAt(0))
}
@@ -225,4 +245,4 @@ export function uint8ArrayToBase64(arrayBuffer: Uint8Array): string {
}
return base64
}
}