@promptbook/ollama 0.103.0-14 → 0.103.0-15

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.
Files changed (49) hide show
  1. package/esm/index.es.js +28 -3
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  4. package/esm/typings/src/_packages/core.index.d.ts +2 -0
  5. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +5 -0
  6. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +9 -0
  7. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  8. package/esm/typings/src/cli/cli-commands/about.d.ts +2 -1
  9. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  10. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  11. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  12. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  13. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  14. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  15. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  16. package/esm/typings/src/cli/cli-commands/start-server.d.ts +2 -1
  17. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  18. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  19. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  20. package/esm/typings/src/config.d.ts +13 -1
  21. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  22. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  23. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  24. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  25. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  26. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  27. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  28. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  29. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  30. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  31. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  32. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  33. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  34. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  35. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  36. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  37. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  38. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  39. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  40. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  41. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  42. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  43. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  44. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  45. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  46. package/esm/typings/src/version.d.ts +1 -1
  47. package/package.json +2 -2
  48. package/umd/index.umd.js +28 -3
  49. package/umd/index.umd.js.map +1 -1
@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
4
4
  *
5
5
  * @private within the scraper directory
6
6
  */
7
- export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
8
- title: string;
9
- packageName: string;
10
- className: string;
11
- mimeTypes: string[];
12
- documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
13
- isAvailableInBrowser: false;
14
- requiredExecutables: never[];
15
- }>;
7
+ export declare const websiteScraperMetadata: any;
16
8
  /**
17
9
  * Registration of known scraper metadata
18
10
  *
@@ -1,4 +1,5 @@
1
1
  import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ import { $side_effect } from '../../utils/organization/$side_effect';
2
3
  /**
3
4
  * Stores data in .env variables
4
5
  *
@@ -29,7 +30,7 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
29
30
  /**
30
31
  * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
31
32
  */
32
- setItem(key: string, value: TItem): Promise<void>;
33
+ setItem(key: string, value: TItem): Promise<$side_effect>;
33
34
  /**
34
35
  * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
35
36
  */
@@ -1,3 +1,4 @@
1
+ import { $side_effect } from '../organization/$side_effect';
1
2
  import type { ExecCommandOptions } from './ExecCommandOptions';
2
3
  /**
3
4
  * Run one command in a shell
@@ -10,7 +11,7 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
10
11
  *
11
12
  * @public exported from `@promptbook/node`
12
13
  */
13
- export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
14
+ export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
14
15
  /**
15
16
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
16
17
  */
@@ -1,3 +1,4 @@
1
+ import { $side_effect } from '../organization/$side_effect';
1
2
  /**
2
3
  * Run multiple commands in a shell in sequence
3
4
  *
@@ -8,7 +9,7 @@
8
9
  *
9
10
  * @public exported from `@promptbook/node`
10
11
  */
11
- export declare function $execCommands({ commands, cwd, crashOnError, }: {
12
+ export declare function $execCommands({ commands, cwd, crashOnError, }: $side_effect & {
12
13
  readonly commands: string[];
13
14
  readonly cwd: string;
14
15
  readonly crashOnError?: boolean;
@@ -0,0 +1,13 @@
1
+ import { string_book } from '../../_packages/types.index';
2
+ import { $side_effect } from '../organization/$side_effect';
3
+ /**
4
+ * Download a Book in a browser
5
+ *
6
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
7
+ *
8
+ * @public exported from `@promptbook/browser`
9
+ */
10
+ export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
11
+ /**
12
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
13
+ */
@@ -0,0 +1,13 @@
1
+ import { string_url } from '../../types/typeAliases';
2
+ import { $side_effect } from '../organization/$side_effect';
3
+ /**
4
+ * Download a File in a browser
5
+ *
6
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
7
+ *
8
+ * @public exported from `@promptbook/browser`
9
+ */
10
+ export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
11
+ /**
12
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
13
+ */
@@ -0,0 +1,46 @@
1
+ import { IDestroyable, Registration } from 'destroyable';
2
+ import { string_mime_type, string_url } from '../../types/typeAliases';
3
+ /**
4
+ * Converts Blob, File or MediaSource to url using URL.createObjectURL
5
+ *
6
+ * @public exported from `@promptbook/browser`
7
+ */
8
+ export declare class ObjectUrl extends Registration implements IDestroyable {
9
+ readonly src: string_url;
10
+ private constructor();
11
+ /**
12
+ * Creates ObjectUrl from multiple input types
13
+ * Note: DO NOT forget to call destroy() when you are done with it
14
+ */
15
+ static from(source: Blob | File | MediaSource | string, mimeType: string_mime_type): ObjectUrl;
16
+ /**
17
+ * Creates ObjectUrl from string
18
+ * Note: DO NOT forget to call destroy() when you are done with it
19
+ */
20
+ static fromString(source: string, mimeType: string_mime_type): ObjectUrl;
21
+ /**
22
+ * Creates ObjectUrl
23
+ * DO NOT forget to call destroy() when you are done with it
24
+ */
25
+ static fromBlob(source: Blob | File | MediaSource): ObjectUrl;
26
+ /**
27
+ * Creates ObjectUrl:
28
+ * 1) With functionality for Blobs, Files or MediaSources
29
+ * 2) Just a wrapper for string urls
30
+ *
31
+ * DO NOT forget to call destroy() when you are done with it
32
+ */
33
+ static fromBlobOrUrl(source: Blob | File | MediaSource | URL | string_url): ObjectUrl;
34
+ /**
35
+ * Gets object url as string
36
+ * @alias src
37
+ */
38
+ get href(): string_url;
39
+ /**
40
+ * Gets object url as URL object
41
+ */
42
+ get url(): URL;
43
+ }
44
+ /**
45
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
46
+ */
@@ -0,0 +1,7 @@
1
+ import { really_any } from './really_any';
2
+ /**
3
+ * Organizational helper to mark a function that produces side effects
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export type $side_effect = void | really_any;
@@ -1,4 +1,5 @@
1
1
  import type { ReadonlyDeep } from 'type-fest';
2
+ import { $side_effect } from '../organization/$side_effect';
2
3
  /**
3
4
  * Freezes the given object and all its nested objects recursively
4
5
  *
@@ -8,7 +9,7 @@ import type { ReadonlyDeep } from 'type-fest';
8
9
  * @returns The same object as the input, but deeply frozen
9
10
  * @public exported from `@promptbook/utils`
10
11
  */
11
- export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
12
+ export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<$side_effect & TObject>;
12
13
  /**
13
14
  * TODO: [🧠] Is there a way how to meaningfully test this utility
14
15
  */
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.103.0-13`).
18
+ * It follows semantic versioning (e.g., `0.103.0-14`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/ollama",
3
- "version": "0.103.0-14",
3
+ "version": "0.103.0-15",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/ollama.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.103.0-14"
97
+ "@promptbook/core": "0.103.0-15"
98
98
  },
99
99
  "dependencies": {
100
100
  "bottleneck": "^2.19.5",
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-14';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-15';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -954,6 +954,17 @@
954
954
  * TODO: Maybe implement by mix+hsl
955
955
  */
956
956
 
957
+ /**
958
+ * Makes color transformer which darker the given color
959
+ *
960
+ * @param amount from 0 to 1
961
+ *
962
+ * @public exported from `@promptbook/color`
963
+ */
964
+ function darken(amount) {
965
+ return lighten(-amount);
966
+ }
967
+
957
968
  /**
958
969
  * Calculates distance between two colors
959
970
  *
@@ -1099,15 +1110,29 @@
1099
1110
  * @public exported from `@promptbook/core`
1100
1111
  */
1101
1112
  const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
1102
- // <- TODO: [🧠] Using `Color` here increases the package size approx 3kb, maybe remove it
1113
+ // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
1114
+ /**
1115
+ * Colors for syntax highlighting in the `<BookEditor/>`
1116
+ *
1117
+ * TODO: [🗽] Unite branding and make single place for it
1118
+ *
1119
+ * @public exported from `@promptbook/core`
1120
+ */
1121
+ ({
1122
+ TITLE: PROMPTBOOK_COLOR.then(darken(0.5)),
1123
+ COMMITMENT: Color.fromHex('#DA0F78'),
1124
+ PARAMETER: Color.fromHex('#8e44ad'),
1125
+ });
1126
+ // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
1103
1127
  /**
1104
- * Dark color of the Promptbook
1128
+ * Chat color of the Promptbook (in chat)
1105
1129
  *
1106
1130
  * TODO: [🗽] Unite branding and make single place for it
1107
1131
  *
1108
1132
  * @public exported from `@promptbook/core`
1109
1133
  */
1110
1134
  PROMPTBOOK_COLOR.then(lighten(0.1)).then(saturate(0.9)).then(grayscale(0.9));
1135
+ // <- TODO: [🧠][🈵] Using `Color` and `lighten`, `saturate`,... here increases the package size approx 3kb, maybe remove it
1111
1136
  /**
1112
1137
  * Color of the user (in chat)
1113
1138
  *