@permaweb/libs 0.0.1-beta

package/dist/types/helpers/utils.d.ts

@@ -0,0 +1,38 @@
+export declare function checkValidAddress(address: string | null): boolean;
+export declare function formatAddress(address: string | null, wrap: boolean): string;
+export declare function getTagValue(list: {
+    [key: string]: any;
+}[], name: string): string | null;
+export declare function formatCount(count: string): string;
+export declare function formatPercentage(percentage: any): string;
+export declare function formatDate(dateArg: string | number | null, dateType: 'iso' | 'epoch', fullTime?: boolean): string | null;
+export declare function getRelativeDate(timestamp: number): string;
+export declare function formatRequiredField(field: string): string;
+export declare function splitTagValue(tag: any): any;
+export declare function getTagDisplay(value: string): string;
+export declare function getDataURLContentType(dataURL: string): string | null;
+export declare function getBase64Data(dataURL: string): string;
+export declare function getByteSize(input: string | Buffer): number;
+export declare function getTotalTokenBalance(tokenBalances: {
+    profileBalance: number;
+    walletBalance: number;
+} | null): number | null;
+export declare function isFirefox(): boolean;
+export declare function reverseDenomination(number: number): number;
+export declare function cleanProcessField(value: string): string;
+export declare function cleanTagValue(value: string): string;
+/**
+ * Extracts all values from a key-value store that match a given prefix
+ * @param store The key-value store object to search
+ * @param prefix The prefix to filter keys by (e.g., 'portal')
+ * @returns Array of values whose keys match the prefix
+ */
+export declare function getStoreNamespace<T = any>(prefix: string, store: Record<string, T>): T[];
+export declare function buildStoreNamespace(prefix: string, value: string): string;
+export declare const globalLog: (...args: any[]) => void;
+export declare function mapToProcessCase(obj: any): any;
+export declare function mapFromProcessCase(obj: any): any;
+export declare function getBootTag(key: string, value: string): {
+    name: string;
+    value: string;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,63 @@
+import * as Helpers from 'helpers';
+import * as Common from './common';
+import * as Services from './services';
+declare function init(deps: Helpers.DependencyType): {
+    createAtomicAsset: (args: Helpers.AssetCreateArgsType, callback?: (status: any) => void) => Promise<string>;
+    getAtomicAsset: (id: string) => Promise<Helpers.AssetDetailType | null>;
+    getAtomicAssets: typeof Services.getAtomicAssets;
+    createComment: (args: Helpers.CommentCreateArgType, callback?: (status: any) => void) => Promise<string>;
+    getComment: (id: string) => Promise<Helpers.CommentDetailType | null>;
+    getComments: (args: {
+        parentId?: string;
+        rootId?: string;
+    }) => Promise<{
+        content: string;
+        dataSource: string;
+        rootSource: string;
+        id: string;
+        owner: string | null;
+        creator: string | null;
+        name: string | null;
+        description: string | null;
+        type: string | null;
+        topics: string[] | null;
+        implementation: string | null;
+        contentType: string | null;
+        renderWith: string | null;
+        thumbnail: string | null;
+        udl: Helpers.UDLicenseType | null;
+        collectionId: string | null;
+        dateCreated: number | null;
+        blockHeight: number | null;
+        tags?: Helpers.TagType[];
+    }[]>;
+    createCollection: (args: {
+        title: string;
+        description: string;
+        creator: string;
+        banner: any;
+        thumbnail: any;
+    }, callback?: (status: any) => void) => Promise<string>;
+    updateCollectionAssets: (args: {
+        collectionId: string;
+        assetIds: string[];
+        creator: string;
+        updateType: "Add" | "Remove";
+    }) => Promise<string>;
+    getCollection: (collectionId: string) => Promise<Helpers.CollectionDetailType | null>;
+    getCollections: (args: {
+        creator?: string;
+    }) => Promise<Helpers.CollectionType[] | null>;
+    resolveTransaction: (data: any) => Promise<any>;
+    getGQLData: typeof Common.getGQLData;
+    createProcess: (args: Helpers.ProcessCreateType, statusCB?: (status: any) => void) => Promise<string>;
+    readProcess: (args: Helpers.MessageSendType) => Promise<any>;
+    sendMessage: (args: Helpers.MessageSendType) => Promise<string>;
+    mapFromProcessCase: typeof Helpers.mapFromProcessCase;
+    mapToProcessCase: typeof Helpers.mapToProcessCase;
+};
+declare const _default: {
+    init: typeof init;
+};
+export default _default;
+export * from './helpers/types';

package/dist/types/services/assets.d.ts

@@ -0,0 +1,7 @@
+import { AoAssetType, AssetCreateArgsType, AssetDetailType, AssetHeaderType, DependencyType, GQLNodeResponseType } from 'helpers/types';
+export declare function createAtomicAssetWith(deps: DependencyType): (args: AssetCreateArgsType, callback?: (status: any) => void) => Promise<string>;
+export declare function getAtomicAsset(deps: DependencyType, id: string): Promise<AssetDetailType | null>;
+export declare function getAtomicAssetWith(deps: DependencyType): (id: string) => Promise<AssetDetailType | null>;
+export declare function getAoAtomicAssetWith(deps: DependencyType): (processId: string) => Promise<AoAssetType>;
+export declare function getAtomicAssets(ids: string[]): Promise<AssetHeaderType[] | null>;
+export declare function buildAsset(element: GQLNodeResponseType): AssetHeaderType;

package/dist/types/services/collections.d.ts

@@ -0,0 +1,18 @@
+import { CollectionDetailType, CollectionType, DependencyType } from 'helpers/types';
+export declare function createCollectionWith(deps: DependencyType): (args: {
+    title: string;
+    description: string;
+    creator: string;
+    banner: any;
+    thumbnail: any;
+}, callback?: (status: any) => void) => Promise<string>;
+export declare function updateCollectionAssetsWith(deps: DependencyType): (args: {
+    collectionId: string;
+    assetIds: string[];
+    creator: string;
+    updateType: "Add" | "Remove";
+}) => Promise<string>;
+export declare function getCollectionWith(deps: DependencyType): (collectionId: string) => Promise<CollectionDetailType | null>;
+export declare function getCollectionsWith(deps: DependencyType): (args: {
+    creator?: string;
+}) => Promise<CollectionType[] | null>;

package/dist/types/services/comments.d.ts

@@ -0,0 +1,27 @@
+import { CommentCreateArgType, CommentDetailType, DependencyType, TagType } from 'helpers/types';
+export declare function createCommentWith(deps: DependencyType): (args: CommentCreateArgType, callback?: (status: any) => void) => Promise<string>;
+export declare function getCommentWith(deps: DependencyType): (id: string) => Promise<CommentDetailType | null>;
+export declare function getCommentsWith(_deps: DependencyType): (args: {
+    parentId?: string;
+    rootId?: string;
+}) => Promise<{
+    content: string;
+    dataSource: string;
+    rootSource: string;
+    id: string;
+    owner: string | null;
+    creator: string | null;
+    name: string | null;
+    description: string | null;
+    type: string | null;
+    topics: string[] | null;
+    implementation: string | null;
+    contentType: string | null;
+    renderWith: string | null;
+    thumbnail: string | null;
+    udl: import("helpers/types").UDLicenseType | null;
+    collectionId: string | null;
+    dateCreated: number | null;
+    blockHeight: number | null;
+    tags?: TagType[];
+}[]>;

package/dist/types/services/index.d.ts

@@ -0,0 +1,5 @@
+export * from './assets';
+export * from './collections';
+export * from './comments';
+export * from './profiles';
+export * from './zones';

package/dist/types/services/profiles.d.ts

@@ -0,0 +1,5 @@
+import { DependencyType, ProfileArgsType, ProfileType } from 'helpers/types';
+export declare function createProfileWith(deps: DependencyType): (args: ProfileArgsType, callback?: (status: any) => void) => Promise<string | null>;
+export declare function updateProfileWith(deps: DependencyType): (args: ProfileArgsType, profileId: string, callback?: (status: any) => void) => Promise<string | null>;
+export declare function getProfileByIdWith(deps: DependencyType): (profileId: string) => Promise<ProfileType | null>;
+export declare function getProfileByWalletAddressWith(deps: DependencyType): (walletAddress: string) => Promise<(ProfileType & any) | null>;

package/dist/types/services/zones.d.ts

@@ -0,0 +1,10 @@
+import { DependencyType, TagType } from 'helpers/types';
+export declare function createZoneWith(deps: DependencyType): (args: {
+    tags?: TagType[];
+}, callback?: (status: any) => void) => Promise<string | null>;
+export declare function updateZoneWith(deps: DependencyType): (args: object, zoneId: string) => Promise<string | null>;
+export declare function addToZoneWith(deps: DependencyType): (args: {
+    path: string;
+    data: object;
+}, zoneId: string) => Promise<string | null>;
+export declare function getZoneWith(deps: DependencyType): (zoneId: string) => Promise<any | null>;

package/package.json

@@ -0,0 +1,65 @@
+{
+	"name": "@permaweb/libs",
+	"version": "0.0.1-beta",
+	"type": "module",
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"browser": "./dist/index.esm.js",
+	"types": "./dist/types/index.d.ts",
+	"typesVersions": {
+		"*": {
+			"browser": [
+				"./dist/types/index.d.ts"
+			],
+			".": [
+				"./dist/types/index.d.ts"
+			]
+		}
+	},
+	"description": "",
+	"files": [
+		"dist"
+	],
+	"keywords": [],
+	"author": "",
+	"license": "ISC",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/permaweb/permaweb-libs.git",
+		"directory": "sdk"
+	},
+	"exports": {
+		".": {
+			"import": "./dist/index.esm.js",
+			"require": "./dist/index.cjs",
+			"default": "./dist/index.js"
+		},
+		"./browser": "./dist/index.esm.js",
+		"./node": "./dist/index.js"
+	},
+	"scripts": {
+		"format": "eslint --fix . && npx prettier --write .",
+		"build": "node build.js"
+	},
+	"dependencies": {
+		"arweave": "^1.15.5",
+		"buffer": "^6.0.3",
+		"process": "^0.11.10",
+		"tsc-alias": "^1.8.10"
+	},
+	"devDependencies": {
+		"@types/async-retry": "^1.4.9",
+		"@types/node": "^22.10.4",
+		"@typescript-eslint/eslint-plugin": "^5.57.1",
+		"@typescript-eslint/parser": "^5.57.1",
+		"esbuild": "^0.24.2",
+		"esbuild-plugin-d.ts": "^1.3.1",
+		"eslint": "^8.35.0",
+		"eslint-plugin-import": "^2.27.5",
+		"eslint-plugin-simple-import-sort": "^10.0.0",
+		"ts-loader": "^9.5.1",
+		"typescript": "^5.7.2",
+		"webpack": "^5.97.1",
+		"webpack-cli": "^6.0.1"
+	}
+}