@rosen-bridge/utils 0.1.0 → 0.3.0

package/dist/lib/utils/github.d.ts

@@ -1,10 +1,11 @@
-import { GithubRelease } from '../types';
+import { GithubRelease, SupportedRepo } from '../types';
 /**
  * Fetch a page of releases from Github Api in each iteration until there are no
  * more releases.
+ * @param repoName
  * @param pageSize
  */
-declare function fetchReleasesPage(pageSize?: number): AsyncGenerator<{
+declare function fetchReleasesPage(repoName: SupportedRepo, pageSize?: number): AsyncGenerator<{
     url: string;
     html_url: string;
     assets_url: string;
@@ -16,94 +17,26 @@ declare function fetchReleasesPage(pageSize?: number): AsyncGenerator<{
     tag_name: string;
     target_commitish: string;
     name: string | null;
-    body?: string | null | undefined;
+    body?: string | null;
     draft: boolean;
     prerelease: boolean;
     created_at: string;
     published_at: string | null;
-    author: {
-        name?: string | null | undefined;
-        email?: string | null | undefined;
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        starred_at?: string | undefined;
-    };
-    assets: {
-        url: string;
-        browser_download_url: string;
-        id: number;
-        node_id: string;
-        name: string;
-        label: string | null;
-        state: "uploaded" | "open";
-        content_type: string;
-        size: number;
-        download_count: number;
-        created_at: string;
-        updated_at: string;
-        uploader: {
-            name?: string | null | undefined;
-            email?: string | null | undefined;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string | undefined;
-        } | null;
-    }[];
-    body_html?: string | undefined;
-    body_text?: string | undefined;
-    mentions_count?: number | undefined;
-    discussion_url?: string | undefined;
-    reactions?: {
-        url: string;
-        total_count: number;
-        "+1": number;
-        "-1": number;
-        laugh: number;
-        confused: number;
-        heart: number;
-        hooray: number;
-        eyes: number;
-        rocket: number;
-    } | undefined;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
 }[], void, unknown>;
 /**
  * Find the last release matching the predicate. If all releases are iterated and
  * no matching release is found, return null.
+ * @param repoName
  * @param predicate
  */
-declare const findLastRelease: (predicate?: (release: GithubRelease) => boolean) => Promise<{
+declare const findLastRelease: (repoName: SupportedRepo, predicate?: (release: GithubRelease) => boolean) => Promise<{
     url: string;
     html_url: string;
     assets_url: string;
@@ -115,93 +48,25 @@ declare const findLastRelease: (predicate?: (release: GithubRelease) => boolean)
     tag_name: string;
     target_commitish: string;
     name: string | null;
-    body?: string | null | undefined;
+    body?: string | null;
     draft: boolean;
     prerelease: boolean;
     created_at: string;
     published_at: string | null;
-    author: {
-        name?: string | null | undefined;
-        email?: string | null | undefined;
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        starred_at?: string | undefined;
-    };
-    assets: {
-        url: string;
-        browser_download_url: string;
-        id: number;
-        node_id: string;
-        name: string;
-        label: string | null;
-        state: "uploaded" | "open";
-        content_type: string;
-        size: number;
-        download_count: number;
-        created_at: string;
-        updated_at: string;
-        uploader: {
-            name?: string | null | undefined;
-            email?: string | null | undefined;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string | undefined;
-        } | null;
-    }[];
-    body_html?: string | undefined;
-    body_text?: string | undefined;
-    mentions_count?: number | undefined;
-    discussion_url?: string | undefined;
-    reactions?: {
-        url: string;
-        total_count: number;
-        "+1": number;
-        "-1": number;
-        laugh: number;
-        confused: number;
-        heart: number;
-        hooray: number;
-        eyes: number;
-        rocket: number;
-    } | undefined;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
 } | null>;
 /**
  * get a GitHub release by its tag
+ * @param repoName
  * @param tag
  */
-declare const getReleaseByTag: (tag: string) => Promise<{
+declare const getReleaseByTag: (repoName: SupportedRepo, tag: string) => Promise<{
     url: string;
     html_url: string;
     assets_url: string;
@@ -213,87 +78,18 @@ declare const getReleaseByTag: (tag: string) => Promise<{
     tag_name: string;
     target_commitish: string;
     name: string | null;
-    body?: string | null | undefined;
+    body?: string | null;
     draft: boolean;
     prerelease: boolean;
     created_at: string;
     published_at: string | null;
-    author: {
-        name?: string | null | undefined;
-        email?: string | null | undefined;
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        starred_at?: string | undefined;
-    };
-    assets: {
-        url: string;
-        browser_download_url: string;
-        id: number;
-        node_id: string;
-        name: string;
-        label: string | null;
-        state: "uploaded" | "open";
-        content_type: string;
-        size: number;
-        download_count: number;
-        created_at: string;
-        updated_at: string;
-        uploader: {
-            name?: string | null | undefined;
-            email?: string | null | undefined;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string | undefined;
-        } | null;
-    }[];
-    body_html?: string | undefined;
-    body_text?: string | undefined;
-    mentions_count?: number | undefined;
-    discussion_url?: string | undefined;
-    reactions?: {
-        url: string;
-        total_count: number;
-        "+1": number;
-        "-1": number;
-        laugh: number;
-        confused: number;
-        heart: number;
-        hooray: number;
-        eyes: number;
-        rocket: number;
-    } | undefined;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
 }>;
 /**
  * Return a function which checks if a release has at least one asset for a
@@ -308,12 +104,24 @@ declare const hasAssetForChainType: (chainType: string) => (release: GithubRelea
  * @param chainType
  */
 declare const isStableReleaseForChainType: (chainType: string) => (release: GithubRelease) => boolean;
+/**
+ * Return a function which checks if tagPrefix is matched with release tag_name
+ * @param tagPrefix
+ */
+declare const hasMatchedTagPrefix: (tagPrefix: string) => (release: GithubRelease) => boolean;
+/**
+ * Return a function which checks if a release is a stable (that is, non-prerelease),
+ * and tagPrefix is matched with release tag_name
+ * @param tagPrefix
+ */
+declare const isStableReleaseForRegexTagType: (tagPrefix: string) => (release: GithubRelease) => boolean;
 /**
  * Find latest release (prerelease or non-prerelease) having some asset matching
  * a specific chain type
+ * @param repoName
  * @param chainType
  */
-declare const findLatestRelease: (chainType: string) => Promise<{
+declare const findLatestRelease: (repoName: SupportedRepo, chainType: string) => Promise<{
     url: string;
     html_url: string;
     assets_url: string;
@@ -325,94 +133,86 @@ declare const findLatestRelease: (chainType: string) => Promise<{
     tag_name: string;
     target_commitish: string;
     name: string | null;
-    body?: string | null | undefined;
+    body?: string | null;
     draft: boolean;
     prerelease: boolean;
     created_at: string;
     published_at: string | null;
-    author: {
-        name?: string | null | undefined;
-        email?: string | null | undefined;
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        starred_at?: string | undefined;
-    };
-    assets: {
-        url: string;
-        browser_download_url: string;
-        id: number;
-        node_id: string;
-        name: string;
-        label: string | null;
-        state: "uploaded" | "open";
-        content_type: string;
-        size: number;
-        download_count: number;
-        created_at: string;
-        updated_at: string;
-        uploader: {
-            name?: string | null | undefined;
-            email?: string | null | undefined;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string | undefined;
-        } | null;
-    }[];
-    body_html?: string | undefined;
-    body_text?: string | undefined;
-    mentions_count?: number | undefined;
-    discussion_url?: string | undefined;
-    reactions?: {
-        url: string;
-        total_count: number;
-        "+1": number;
-        "-1": number;
-        laugh: number;
-        confused: number;
-        heart: number;
-        hooray: number;
-        eyes: number;
-        rocket: number;
-    } | undefined;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
 } | null>;
 /**
  * Find latest stable (that is, non-prerelease) release having some asset matching
  * a specific chain type
+ * @param repoName
  * @param chainType
  */
-declare const findLatestStableRelease: (chainType: string) => Promise<{
+declare const findLatestStableRelease: (repoName: SupportedRepo, chainType: string) => Promise<{
+    url: string;
+    html_url: string;
+    assets_url: string;
+    upload_url: string;
+    tarball_url: string | null;
+    zipball_url: string | null;
+    id: number;
+    node_id: string;
+    tag_name: string;
+    target_commitish: string;
+    name: string | null;
+    body?: string | null;
+    draft: boolean;
+    prerelease: boolean;
+    created_at: string;
+    published_at: string | null;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
+} | null>;
+/**
+ * Find the latest stable (that is, non-prerelease) release that tagPrefix is matched with release tag_name
+ * @param repoName
+ * @param tagPrefix
+ */
+declare const findLatestStableReleaseByPrefixTag: (repoName: SupportedRepo, tagPrefix: string) => Promise<{
+    url: string;
+    html_url: string;
+    assets_url: string;
+    upload_url: string;
+    tarball_url: string | null;
+    zipball_url: string | null;
+    id: number;
+    node_id: string;
+    tag_name: string;
+    target_commitish: string;
+    name: string | null;
+    body?: string | null;
+    draft: boolean;
+    prerelease: boolean;
+    created_at: string;
+    published_at: string | null;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
+} | null>;
+/**
+ * Find the latest release that tagPrefix is matched with release tag_name
+ * @param repoName
+ * @param tagPrefix
+ */
+declare const findLatestReleaseByPrefixTag: (repoName: SupportedRepo, tagPrefix: string) => Promise<{
     url: string;
     html_url: string;
     assets_url: string;
@@ -424,87 +224,18 @@ declare const findLatestStableRelease: (chainType: string) => Promise<{
     tag_name: string;
     target_commitish: string;
     name: string | null;
-    body?: string | null | undefined;
+    body?: string | null;
     draft: boolean;
     prerelease: boolean;
     created_at: string;
     published_at: string | null;
-    author: {
-        name?: string | null | undefined;
-        email?: string | null | undefined;
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        starred_at?: string | undefined;
-    };
-    assets: {
-        url: string;
-        browser_download_url: string;
-        id: number;
-        node_id: string;
-        name: string;
-        label: string | null;
-        state: "uploaded" | "open";
-        content_type: string;
-        size: number;
-        download_count: number;
-        created_at: string;
-        updated_at: string;
-        uploader: {
-            name?: string | null | undefined;
-            email?: string | null | undefined;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string | undefined;
-        } | null;
-    }[];
-    body_html?: string | undefined;
-    body_text?: string | undefined;
-    mentions_count?: number | undefined;
-    discussion_url?: string | undefined;
-    reactions?: {
-        url: string;
-        total_count: number;
-        "+1": number;
-        "-1": number;
-        laugh: number;
-        confused: number;
-        heart: number;
-        hooray: number;
-        eyes: number;
-        rocket: number;
-    } | undefined;
+    author: import("@octokit/openapi-types").components["schemas"]["simple-user"];
+    assets: import("@octokit/openapi-types").components["schemas"]["release-asset"][];
+    body_html?: string;
+    body_text?: string;
+    mentions_count?: number;
+    discussion_url?: string;
+    reactions?: import("@octokit/openapi-types").components["schemas"]["reaction-rollup"];
 } | null>;
-export { fetchReleasesPage, findLastRelease, findLatestRelease, findLatestStableRelease, getReleaseByTag, hasAssetForChainType, isStableReleaseForChainType, };
+export { fetchReleasesPage, findLastRelease, findLatestRelease, findLatestStableRelease, findLatestStableReleaseByPrefixTag, findLatestReleaseByPrefixTag, getReleaseByTag, hasAssetForChainType, isStableReleaseForChainType, isStableReleaseForRegexTagType, hasMatchedTagPrefix, };
 //# sourceMappingURL=github.d.ts.map

package/dist/lib/utils/github.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../../../lib/utils/github.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;;;GAIG;AACH,iBAAgB,iBAAiB,CAC/B,QAAQ,SAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAqB/C;AAED;;;;GAIG;AACH,QAAA,MAAM,eAAe,yBACE,aAAa,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAY/C,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,eAAe,QAAe,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASzC,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,oBAAoB,cAAe,MAAM,eAAe,aAAa,YACE,CAAC;AAE9E;;;;GAIG;AACH,QAAA,MAAM,2BAA2B,cACnB,MAAM,eAAe,aAAa,YACmB,CAAC;AAEpE;;;;GAIG;AACH,QAAA,MAAM,iBAAiB,cAAqB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SACA,CAAC;AAEnD;;;;GAIG;AACH,QAAA,MAAM,uBAAuB,cAAqB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SACC,CAAC;AAE1D,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,EACf,oBAAoB,EACpB,2BAA2B,GAC5B,CAAC"}
+{"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../../../lib/utils/github.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAExD;;;;;GAKG;AACH,iBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,aAAa,EACvB,QAAQ,SAAsC;;;;;;;;;;;;;;;;;YAsJsor0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;oBAjI/gs0B;AAED;;;;;GAKG;AACH,QAAA,MAAM,eAAe,GACnB,UAAU,aAAa,EACvB,YAAW,CAAC,OAAO,EAAE,aAAa,KAAK,OAAoB;;;;;;;;;;;;;;;;;YAuHynr0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;SA3G/gs0B,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,eAAe,GAAU,UAAU,aAAa,EAAE,KAAK,MAAM;;;;;;;;;;;;;;;;;YAoGmnr0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;EA3F/gs0B,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,oBAAoB,GAAI,WAAW,MAAM,MAAM,SAAS,aAAa,YACE,CAAC;AAE9E;;;;GAIG;AACH,QAAA,MAAM,2BAA2B,GAC9B,WAAW,MAAM,MAAM,SAAS,aAAa,YACmB,CAAC;AAEpE;;;GAGG;AACH,QAAA,MAAM,mBAAmB,GAAI,WAAW,MAAM,MAAM,SAAS,aAAa,YAGzE,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,8BAA8B,GACjC,WAAW,MAAM,MAAM,SAAS,aAAa,YACkB,CAAC;AAEnE;;;;;GAKG;AACH,QAAA,MAAM,iBAAiB,GAAU,UAAU,aAAa,EAAE,WAAW,MAAM;;;;;;;;;;;;;;;;;YA+C2mr0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;SA9Cp9r0B,CAAC;AAE7D;;;;;GAKG;AACH,QAAA,MAAM,uBAAuB,GAC3B,UAAU,aAAa,EACvB,WAAW,MAAM;;;;;;;;;;;;;;;;;YAoCmqr0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;SAnC18r0B,CAAC;AAEvE;;;;GAIG;AACH,QAAA,MAAM,kCAAkC,GACtC,UAAU,aAAa,EACvB,WAAW,MAAM;;;;;;;;;;;;;;;;;YA0Bmqr0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;SAzBv8r0B,CAAC;AAE1E;;;;GAIG;AACH,QAAA,MAAM,4BAA4B,GAChC,UAAU,aAAa,EACvB,WAAW,MAAM;;;;;;;;;;;;;;;;;YAgBmqr0B,sDAAsB;YAA8B,sDAAsB;;;;;gBAA0P,sDAAsB;SAfl9r0B,CAAC;AAE/D,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,eAAe,EACf,oBAAoB,EACpB,2BAA2B,EAC3B,8BAA8B,EAC9B,mBAAmB,GACpB,CAAC"}