@promptbook/javascript 0.111.0-7 → 0.112.0-11

package/esm/src/types/string_person_fullname.d.ts

@@ -0,0 +1,85 @@
+import type { string_title } from './string_parameter_name';
+/**
+ * Semantic helper
+ *
+ * For example `"John Smith"`
+ */
+export type string_person_fullname = `${string_person_firstname} ${string_person_lastname}` | string;
+/**
+ * Semantic helper
+ *
+ * For example `"John Smith"`
+ */
+export type string_person_firstname = string;
+/**
+ * Semantic helper
+ *
+ * For example `"John Smith"`
+ */
+export type string_person_lastname = string;
+/**
+ * Semantic helper
+ * Full profile of the person with his email and web (like in package.json)
+ *
+ * For example `"Pavol Hejný <pavol@hejny.org> (https://pavolhejny.com)"`
+ */
+export type string_person_profile = string;
+/**
+ * Semantic helper
+ *
+ * For example `"MIT"`
+ */
+export type string_license = string;
+/**
+ * Semantic helper
+ *
+ * For example `"Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"`
+ * For example `"AI Web, LLC <legal@ptbk.io> (https://www.ptbk.io/)"`
+ */
+export type string_legal_entity = string | string_person_profile | string_title;
+/**
+ * Semantic helper for attributes
+ *
+ * - case insensitive
+ *
+ * For example `"color"`
+ */
+export type string_attribute = string;
+/**
+ * Semantic helper for attributes context
+ * Each attribute value scope with a attribute name has its own current value
+ *
+ * - case insensitive
+ *
+ * For example `"tools"`
+ */
+export type string_attribute_value_scope = string;
+/**
+ * Semantic helper for css/html colors
+ *
+ * For example `"white"` or `"#009edd"`
+ */
+export type string_color = string;
+/**
+ * Semantic helper; For example "SHARE_ICON/EDIT_LINK"
+ */
+export type string_translate_name = string;
+/**
+ * Semantic helper; For example "ShareIcon/ edit link"
+ */
+export type string_translate_name_not_normalized = string;
+/**
+ * Semantic helper; For example "cs" or "en"
+ * Implementing ISO 639-1
+ *
+ * TODO: Probably use enum
+ */
+export type string_translate_language = 'en' | 'cs';
+/**
+ * Semantic helper; For example "callbackName" or "renderMe"
+ */
+export type string_javascript_name = string;
+/**
+ * Semantic helper; For example "unwrapResult" or "spaceTrim"
+ */
+export type string_postprocessing_function_name = string;

package/esm/src/types/string_sha256.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Branded type for UUIDs version 4
+ * This will not allow to pass some random string where should be only a valid UUID
+ *
+ * Use utils:
+ *   - `randomUuid` to generate
+ *   - `isValidUuid  to check validity
+ *
+ * For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
+ * TODO: [🥬] Make some system for hashes and ids of promptbook
+ */
+export type string_uuid = string & {
+    readonly _type: 'uuid';
+};
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ */
+export type string_sha256 = string;
+/**
+ * Semantic helper
+ *
+ * For example `"4JmF3b2J5dGVz"`
+ */
+export type string_base_58 = string;
+/**
+ * Semantic helper
+ *
+ * For example `"4.2.4"`
+ */
+export type string_semantic_version = string;
+/**
+ * Semantic helper
+ *
+ * For example `"^4.2.4"`
+ */
+export type string_version_dependency = string;
+/**
+ * Semantic helper
+ *
+ * For example `"png"`
+ */
+export type string_file_extension = string;

package/esm/src/types/string_token.d.ts

@@ -0,0 +1,58 @@
+import type { string_email } from './string_url';
+/**
+ * Generic identifier helper.
+ */
+export type id = string | number;
+/**
+ * Task identifier helper.
+ */
+export type task_id = string;
+/**
+ * Token string helper.
+ */
+export type string_token = string;
+/**
+ * Semantic helper
+ *
+ * Made by `identificationToPromptbookToken` exported from `@promptbook/core`
+ */
+export type string_promptbook_token = string_token;
+/**
+ * License token helper.
+ */
+export type string_license_token = string_token;
+/**
+ * Password helper.
+ */
+export type string_password = string;
+/**
+ * SSH key helper.
+ */
+export type string_ssh_key = string;
+/**
+ * PGP key helper.
+ */
+export type string_pgp_key = string;
+/**
+ * Language as a string, e.g. 'en-US', 'cs-CZ', 'en'
+ */
+export type string_language = string;
+/**
+ * Semantic helper for `Date.toISOString()` result
+ *
+ * @example "2011-10-05T14:48:00.000Z".
+ * @see https://en.wikipedia.org/wiki/ISO_8601
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
+ */
+export type string_date_iso8601 = `${number}-${number}-${number}${string}${number}:${number}:${number}${string}`;
+/**
+ * Application identifier, used to distinguish different apps or clients.
+ *
+ * For example: 'cli', 'playground', or a custom app id.
+ */
+export type string_app_id = id | 'app';
+/**
+ * End user identifier, can be a user id or email address.
+ * Used for tracking and abuse prevention.
+ */
+export type string_user_id = id | string_email;

package/esm/src/types/string_url.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Semantic helper
+ *
+ * For example `"text/plain"` or `"application/collboard"`
+ */
+export type string_mime_type = string;
+/**
+ * Semantic helper
+ *
+ * For example `"text/*"` or `"image/*"`
+ *
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
+ */
+export type string_mime_type_with_wildcard = string;
+/**
+ * Semantic helper
+ *
+ * For example `"towns.cz"`
+ */
+export type string_domain = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://*.pavolhejny.com/*"`
+ */
+export type string_origin = string;
+/**
+ * Semantic helper
+ *
+ * For example `"com"`
+ */
+export type string_tdl = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
+ */
+export type string_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ */
+export type string_promptbook_server_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com"`
+ */
+export type string_base_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/"`
+ */
+export type string_pipeline_root_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
+ */
+export type string_agent_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
+ */
+export type string_pipeline_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
+ */
+export type string_pipeline_url_with_task_hash = string;
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_base64 = string;
+/**
+ * Semantic helper
+ *
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
+ */
+export type string_href = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
+ */
+export type string_url_image = string;
+/**
+ * Semantic helper
+ *
+ * For example `"/9SeSQTupmQHwuSrLi"`
+ */
+export type string_uri = string;
+/**
+ * Semantic helper
+ *
+ * For example `"9SeSQTupmQHwuSrLi"`
+ */
+export type string_uri_part = string;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost"` or `"collboard.com"`
+ */
+export type string_hostname = string;
+/**
+ * Semantic helper
+ *
+ * For example `"localhost:9977"` or `"collboard.com"`
+ */
+export type string_host = string;
+/**
+ * Semantic helper
+ */
+export type string_protocol = 'http:' | 'https:';
+/**
+ * Semantic helper
+ *
+ * For example `"192.168.1.1"` (IPv4)
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
+ */
+export type string_ip_address = string;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org"`
+ */
+export type string_email = string;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org, jirka@webgpt.cz"`
+ */
+export type string_emails = string;