@dbx-tools/appkit-generator 0.0.0-stage → 0.9.138

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,182 @@
-# Temporary Holding Version
+# @dbx-tools/appkit-generator
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Generate researched brand contexts or provision a governed Databricks demo
+environment from business questions. The package exposes every operation as an
+AppKit tool and composes them through a registered Mastra workflow.
+
+## Register the plugin
+
+Register `webSearch()`, `generator()`, and `mastra()` in the same AppKit application:
+
+```ts
+import { createApp, server } from "@databricks/appkit";
+import { generator } from "@dbx-tools/appkit-generator";
+import { webSearch } from "@dbx-tools/appkit-web-search";
+import { mastra } from "@dbx-tools/appkit-mastra";
+
+const appkit = await createApp({
+  plugins: [server(), webSearch(), mastra(), generator()],
+});
+
+const generated = await appkit.generator.generateBrand({
+  name: "Databricks",
+  website: "https://www.databricks.com/",
+});
+
+const { brand: brandContext, sources } = generated;
+```
+
+The generated package contains:
+
+- Canonical and short names, tagline, and description.
+- Application colors and CSS font stacks.
+- Audience, tone, writing principles, and patterns to avoid.
+- Official website, documentation, and repository links when found.
+- Logo, icon, and favicon URLs discovered from official page markup.
+- Supplemental iOS and Android app references used for visual direction.
+- Source provenance, including whether each cited page was fetched.
+
+The optional website disambiguates similarly named brands and is placed first
+in the source candidates. Omit it when the brand has one clear public identity.
+
+## Give the tools to an agent
+
+The plugin implements AppKit's `ToolProvider`. A native AppKit agent can opt in
+to individual generator tools:
+
+```ts
+import { createAgent } from "@databricks/appkit/beta";
+
+export default createAgent({
+  name: "Brand researcher",
+  model: "databricks-gpt-6-1-sol",
+  instructions: "Research and generate approved Databricks demo assets.",
+  tools: (plugins) => ({ ...plugins.generator.toolkit({ prefix: "" }) }),
+});
+```
+
+Read-only tools cover brand and KPI research plus typed planning. Mutating tools
+provision schemas, materialize data, and create dashboard or Genie assets under
+the requesting user's OBO context. They are never auto-inherited.
+
+## Stream progress in a browser
+
+The plugin publishes its mounted base path through `clientConfig()` and serves
+`POST /generate` as Server-Sent Events. Use the browser-safe client instead of
+hard-coding the route:
+
+```ts
+import {
+  GENERATOR_PLUGIN_NAME,
+  GeneratorPluginClient,
+  type GeneratorClientConfig,
+} from "@dbx-tools/shared-generator/brand";
+import { usePluginClientConfig } from "@dbx-tools/ui/react";
+
+const config = usePluginClientConfig<GeneratorClientConfig>(GENERATOR_PLUGIN_NAME);
+const client = new GeneratorPluginClient(config);
+
+for await (const event of client.generate({ name: "Databricks" })) {
+  if (event.type === "progress") updateActivity(event);
+  if (event.type === "result") applyBrand(event.package.brand);
+}
+```
+
+Progress stages report source search, page fetches, asset inspection, and
+structured synthesis. The terminal result includes the generated context and
+source provenance.
+
+## Run the demo-asset workflow
+
+The registered `generatorDemoAssets` Mastra workflow accepts a company, purpose,
+business questions, presentation mode, and bounded row count. It:
+
+1. Researches brand assets and KPIs from cited web sources.
+2. Produces a Zod-validated data plan without model-authored SQL.
+3. Suspends for approval before any mutation.
+4. Has the app service principal create and mark a deterministic per-user schema.
+5. Grants the active OBO user `ALL_PRIVILEGES` and `MANAGE`.
+6. Materializes deterministic Delta data and validates every KPI.
+7. Publishes an AI/BI dashboard with automatic companion Genie, or creates one
+   standalone Genie space when dashboard mode is not requested.
+
+Schema names derive from the trusted user name, company, and purpose. Ownership
+markers prevent a slug collision from adopting another user's schema.
+
+## How brand generation works
+
+One request performs the following bounded workflow:
+
+1. `web_search` asks for first-party identity, voice, visual, and link evidence.
+2. Separate searches find relevant iOS App Store and Google Play listings.
+3. `web_fetch` reads up to four cited pages by default and visits matching app
+   listings for supplemental visual references.
+4. The likely official page is also fetched as HTML for deterministic logo,
+   icon, and favicon discovery.
+5. Representative app icons and screenshots are fetched and included in the
+   structured model call with the broader web evidence.
+6. The package normalizes action and text colors to WCAG AA contrast, then
+   `BrandContextSchema` validates the final portable context.
+
+Fetched page text is treated as untrusted reference data. Embedded instructions
+are excluded from the synthesis instructions. Link fields must use URLs present
+in the research evidence. Asset URLs come from the official page markup, with
+`/favicon.ico` on that origin as the icon fallback.
+
+The package returns official brand asset URLs and mobile-reference metadata.
+Mobile images are held in memory during synthesis so an exporter can persist
+them separately as references. They are not substituted for the generated
+brand identity and the package does not grant rights to third-party artwork.
+
+## Configure generation
+
+Pass options to `brand()`:
+
+```ts
+generator({
+  model: "databricks-claude-sonnet-4-6",
+  catalog: "main",
+  warehouseId: "abc123",
+  maxSources: 6,
+  sourceMaxLength: 12_000,
+  timeoutMs: 180_000,
+});
+```
+
+`model` accepts a deployed endpoint name or loose model request resolved by
+`@dbx-tools/appkit-mastra`. When omitted, the live workspace model resolver
+selects the endpoint.
+
+The equivalent environment variables are:
+
+- `GENERATOR_MODEL`
+- `GENERATOR_CATALOG`
+- `GENERATOR_MAX_SOURCES`
+- `GENERATOR_SOURCE_MAX_LENGTH`
+- `GENERATOR_TIMEOUT_MS`
+- `DATABRICKS_WAREHOUSE_ID`
+
+The source count is capped at eight and each excerpt at 20,000 characters.
+Whole-package results are cached for six hours per AppKit execution identity.
+Search and page reads keep the independent cache, retry, timeout, and URL-policy settings owned by
+`@dbx-tools/appkit-web-search`.
+
+## Use the result
+
+Apply the generated context with the shared React branding provider:
+
+```tsx
+import type { BrandContext } from "@dbx-tools/shared-core/brand-utils";
+import { BrandProvider } from "@dbx-tools/ui/branding/react";
+
+export function App({ brand }: { brand: BrandContext }) {
+  return (
+    <BrandProvider context={brand} applyToDocument>
+      <Application />
+    </BrandProvider>
+  );
+}
+```
+
+The same context can be converted for delivered email with
+`emailBrandFromContext` from `@dbx-tools/shared-email-template`.

package/index.ts

@@ -0,0 +1,44 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+
+export const PACKAGE_IDENTIFIER = "@dbx-tools/appkit-generator";
+export const PACKAGE_VERSION = "0.9.138";
+export * as assets from "./src/assets.ts";
+export * as config from "./src/config.ts";
+export * as dashboard from "./src/dashboard.ts";
+export * as data from "./src/data.ts";
+export * as defaults from "./src/defaults.ts";
+export * as generate from "./src/generate.ts";
+export * as genie from "./src/genie.ts";
+export * as kpi from "./src/kpi.ts";
+export * as namespace from "./src/namespace.ts";
+export * as operations from "./src/operations.ts";
+export * as palette from "./src/palette.ts";
+export * as plan from "./src/plan.ts";
+export * as plugin from "./src/plugin.ts";
+export * as research from "./src/research.ts";
+export * as schema from "./src/schema.ts";
+export * as structured from "./src/structured.ts";
+export * as workflow from "./src/workflow.ts";
+export type { DiscoveredBrandAssets, DiscoveredMobileAppVisuals } from "./src/assets.ts";
+export { DEFAULT_GENERATOR_TIMEOUT_MS, GENERATOR_CONFIG_SCHEMA } from "./src/config.ts";
+export type { GeneratorPluginConfig, ResolvedGeneratorConfig } from "./src/config.ts";
+export type { CreateGeneratorDashboardInput } from "./src/dashboard.ts";
+export { BRAND_CACHE_TTL_SECONDS, BRAND_CACHE_VERSION, BRAND_GENERATION_ATTEMPTS } from "./src/defaults.ts";
+export type { BrandExecuteConfig, BrandExecutionSettings } from "./src/defaults.ts";
+export { BRAND_SYNTHESIS_INSTRUCTIONS } from "./src/generate.ts";
+export type { BrandSynthesisInput, BrandSynthesizer, GenerateBrandPackageOptions } from "./src/generate.ts";
+export type { CreateGeneratorGenieInput } from "./src/genie.ts";
+export type { ResearchKpisOptions } from "./src/kpi.ts";
+export type { ProvisionSchemaInput, GeneratorIdentity } from "./src/namespace.ts";
+export { GeneratorOperations } from "./src/operations.ts";
+export type { GeneratorOperationsOptions } from "./src/operations.ts";
+export type { PlanGeneratorDataInput } from "./src/plan.ts";
+export { GeneratorPlugin, generator } from "./src/plugin.ts";
+export { DEFAULT_MAX_SOURCES, DEFAULT_SOURCE_MAX_LENGTH, MAX_SOURCES, MAX_SOURCE_MAX_LENGTH, ASSET_HTML_MAX_LENGTH } from "./src/research.ts";
+export type { BrandResearchClient, BrandResearchOptions, BrandProgressReporter, BrandResearchSource, BrandResearch, BrandResearchVisualImage, BrandResearchVisualReference } from "./src/research.ts";
+export { GENERATE_BRAND_TOOL_DESCRIPTION, GeneratedBrandProfileSchema } from "./src/schema.ts";
+export type { GeneratedBrandProfile } from "./src/schema.ts";
+export type { StructuredGenerationOptions } from "./src/structured.ts";
+export type { GeneratorWorkflowOperations, GeneratorWorkflowOptions, GeneratorWorkflow } from "./src/workflow.ts";

package/lib/index.d.ts

@@ -0,0 +1,40 @@
+export declare const PACKAGE_IDENTIFIER = "@dbx-tools/appkit-generator";
+export declare const PACKAGE_VERSION = "0.9.138";
+export * as assets from "./src/assets.ts";
+export * as config from "./src/config.ts";
+export * as dashboard from "./src/dashboard.ts";
+export * as data from "./src/data.ts";
+export * as defaults from "./src/defaults.ts";
+export * as generate from "./src/generate.ts";
+export * as genie from "./src/genie.ts";
+export * as kpi from "./src/kpi.ts";
+export * as namespace from "./src/namespace.ts";
+export * as operations from "./src/operations.ts";
+export * as palette from "./src/palette.ts";
+export * as plan from "./src/plan.ts";
+export * as plugin from "./src/plugin.ts";
+export * as research from "./src/research.ts";
+export * as schema from "./src/schema.ts";
+export * as structured from "./src/structured.ts";
+export * as workflow from "./src/workflow.ts";
+export type { DiscoveredBrandAssets, DiscoveredMobileAppVisuals } from "./src/assets.ts";
+export { DEFAULT_GENERATOR_TIMEOUT_MS, GENERATOR_CONFIG_SCHEMA } from "./src/config.ts";
+export type { GeneratorPluginConfig, ResolvedGeneratorConfig } from "./src/config.ts";
+export type { CreateGeneratorDashboardInput } from "./src/dashboard.ts";
+export { BRAND_CACHE_TTL_SECONDS, BRAND_CACHE_VERSION, BRAND_GENERATION_ATTEMPTS } from "./src/defaults.ts";
+export type { BrandExecuteConfig, BrandExecutionSettings } from "./src/defaults.ts";
+export { BRAND_SYNTHESIS_INSTRUCTIONS } from "./src/generate.ts";
+export type { BrandSynthesisInput, BrandSynthesizer, GenerateBrandPackageOptions } from "./src/generate.ts";
+export type { CreateGeneratorGenieInput } from "./src/genie.ts";
+export type { ResearchKpisOptions } from "./src/kpi.ts";
+export type { ProvisionSchemaInput, GeneratorIdentity } from "./src/namespace.ts";
+export { GeneratorOperations } from "./src/operations.ts";
+export type { GeneratorOperationsOptions } from "./src/operations.ts";
+export type { PlanGeneratorDataInput } from "./src/plan.ts";
+export { GeneratorPlugin, generator } from "./src/plugin.ts";
+export { DEFAULT_MAX_SOURCES, DEFAULT_SOURCE_MAX_LENGTH, MAX_SOURCES, MAX_SOURCE_MAX_LENGTH, ASSET_HTML_MAX_LENGTH } from "./src/research.ts";
+export type { BrandResearchClient, BrandResearchOptions, BrandProgressReporter, BrandResearchSource, BrandResearch, BrandResearchVisualImage, BrandResearchVisualReference } from "./src/research.ts";
+export { GENERATE_BRAND_TOOL_DESCRIPTION, GeneratedBrandProfileSchema } from "./src/schema.ts";
+export type { GeneratedBrandProfile } from "./src/schema.ts";
+export type { StructuredGenerationOptions } from "./src/structured.ts";
+export type { GeneratorWorkflowOperations, GeneratorWorkflowOptions, GeneratorWorkflow } from "./src/workflow.ts";

package/lib/index.js

@@ -0,0 +1,30 @@
+// GENERATED by projen watch - DO NOT EDIT.
+// Regenerated from the exporting modules in ./src.
+// Hand edits are overwritten on the next watch; this file is read-only.
+export const PACKAGE_IDENTIFIER = "@dbx-tools/appkit-generator";
+export const PACKAGE_VERSION = "0.9.138";
+export * as assets from "./src/assets.js";
+export * as config from "./src/config.js";
+export * as dashboard from "./src/dashboard.js";
+export * as data from "./src/data.js";
+export * as defaults from "./src/defaults.js";
+export * as generate from "./src/generate.js";
+export * as genie from "./src/genie.js";
+export * as kpi from "./src/kpi.js";
+export * as namespace from "./src/namespace.js";
+export * as operations from "./src/operations.js";
+export * as palette from "./src/palette.js";
+export * as plan from "./src/plan.js";
+export * as plugin from "./src/plugin.js";
+export * as research from "./src/research.js";
+export * as schema from "./src/schema.js";
+export * as structured from "./src/structured.js";
+export * as workflow from "./src/workflow.js";
+export { DEFAULT_GENERATOR_TIMEOUT_MS, GENERATOR_CONFIG_SCHEMA } from "./src/config.js";
+export { BRAND_CACHE_TTL_SECONDS, BRAND_CACHE_VERSION, BRAND_GENERATION_ATTEMPTS } from "./src/defaults.js";
+export { BRAND_SYNTHESIS_INSTRUCTIONS } from "./src/generate.js";
+export { GeneratorOperations } from "./src/operations.js";
+export { GeneratorPlugin, generator } from "./src/plugin.js";
+export { DEFAULT_MAX_SOURCES, DEFAULT_SOURCE_MAX_LENGTH, MAX_SOURCES, MAX_SOURCE_MAX_LENGTH, ASSET_HTML_MAX_LENGTH } from "./src/research.js";
+export { GENERATE_BRAND_TOOL_DESCRIPTION, GeneratedBrandProfileSchema } from "./src/schema.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyw2QkFBNkIsQ0FBQztBQUNoRSxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLE1BQU0sTUFBTSxpQkFBaUIsQ0FBQztBQUMxQyxPQUFPLEtBQUssU0FBUyxNQUFNLG9CQUFvQixDQUFDO0FBQ2hELE9BQU8sS0FBSyxJQUFJLE1BQU0sZUFBZSxDQUFDO0FBQ3RDLE9BQU8sS0FBSyxRQUFRLE1BQU0sbUJBQW1CLENBQUM7QUFDOUMsT0FBTyxLQUFLLFFBQVEsTUFBTSxtQkFBbUIsQ0FBQztBQUM5QyxPQUFPLEtBQUssS0FBSyxNQUFNLGdCQUFnQixDQUFDO0FBQ3hDLE9BQU8sS0FBSyxHQUFHLE1BQU0sY0FBYyxDQUFDO0FBQ3BDLE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLFVBQVUsTUFBTSxxQkFBcUIsQ0FBQztBQUNsRCxPQUFPLEtBQUssT0FBTyxNQUFNLGtCQUFrQixDQUFDO0FBQzVDLE9BQU8sS0FBSyxJQUFJLE1BQU0sZUFBZSxDQUFDO0FBQ3RDLE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLFFBQVEsTUFBTSxtQkFBbUIsQ0FBQztBQUM5QyxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sS0FBSyxVQUFVLE1BQU0scUJBQXFCLENBQUM7QUFDbEQsT0FBTyxLQUFLLFFBQVEsTUFBTSxtQkFBbUIsQ0FBQztBQUU5QyxPQUFPLEVBQUUsNEJBQTRCLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUd4RixPQUFPLEVBQUUsdUJBQXVCLEVBQUUsbUJBQW1CLEVBQUUseUJBQXlCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUU1RyxPQUFPLEVBQUUsNEJBQTRCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUtqRSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUcxRCxPQUFPLEVBQUUsZUFBZSxFQUFFLFNBQVMsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBQzdELE9BQU8sRUFBRSxtQkFBbUIsRUFBRSx5QkFBeUIsRUFBRSxXQUFXLEVBQUUscUJBQXFCLEVBQUUscUJBQXFCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUU5SSxPQUFPLEVBQUUsK0JBQStCLEVBQUUsMkJBQTJCLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvYXBwa2l0LWdlbmVyYXRvclwiO1xuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfVkVSU0lPTiA9IFwiMC45LjEzOFwiO1xuZXhwb3J0ICogYXMgYXNzZXRzIGZyb20gXCIuL3NyYy9hc3NldHMudHNcIjtcbmV4cG9ydCAqIGFzIGNvbmZpZyBmcm9tIFwiLi9zcmMvY29uZmlnLnRzXCI7XG5leHBvcnQgKiBhcyBkYXNoYm9hcmQgZnJvbSBcIi4vc3JjL2Rhc2hib2FyZC50c1wiO1xuZXhwb3J0ICogYXMgZGF0YSBmcm9tIFwiLi9zcmMvZGF0YS50c1wiO1xuZXhwb3J0ICogYXMgZGVmYXVsdHMgZnJvbSBcIi4vc3JjL2RlZmF1bHRzLnRzXCI7XG5leHBvcnQgKiBhcyBnZW5lcmF0ZSBmcm9tIFwiLi9zcmMvZ2VuZXJhdGUudHNcIjtcbmV4cG9ydCAqIGFzIGdlbmllIGZyb20gXCIuL3NyYy9nZW5pZS50c1wiO1xuZXhwb3J0ICogYXMga3BpIGZyb20gXCIuL3NyYy9rcGkudHNcIjtcbmV4cG9ydCAqIGFzIG5hbWVzcGFjZSBmcm9tIFwiLi9zcmMvbmFtZXNwYWNlLnRzXCI7XG5leHBvcnQgKiBhcyBvcGVyYXRpb25zIGZyb20gXCIuL3NyYy9vcGVyYXRpb25zLnRzXCI7XG5leHBvcnQgKiBhcyBwYWxldHRlIGZyb20gXCIuL3NyYy9wYWxldHRlLnRzXCI7XG5leHBvcnQgKiBhcyBwbGFuIGZyb20gXCIuL3NyYy9wbGFuLnRzXCI7XG5leHBvcnQgKiBhcyBwbHVnaW4gZnJvbSBcIi4vc3JjL3BsdWdpbi50c1wiO1xuZXhwb3J0ICogYXMgcmVzZWFyY2ggZnJvbSBcIi4vc3JjL3Jlc2VhcmNoLnRzXCI7XG5leHBvcnQgKiBhcyBzY2hlbWEgZnJvbSBcIi4vc3JjL3NjaGVtYS50c1wiO1xuZXhwb3J0ICogYXMgc3RydWN0dXJlZCBmcm9tIFwiLi9zcmMvc3RydWN0dXJlZC50c1wiO1xuZXhwb3J0ICogYXMgd29ya2Zsb3cgZnJvbSBcIi4vc3JjL3dvcmtmbG93LnRzXCI7XG5leHBvcnQgdHlwZSB7IERpc2NvdmVyZWRCcmFuZEFzc2V0cywgRGlzY292ZXJlZE1vYmlsZUFwcFZpc3VhbHMgfSBmcm9tIFwiLi9zcmMvYXNzZXRzLnRzXCI7XG5leHBvcnQgeyBERUZBVUxUX0dFTkVSQVRPUl9USU1FT1VUX01TLCBHRU5FUkFUT1JfQ09ORklHX1NDSEVNQSB9IGZyb20gXCIuL3NyYy9jb25maWcudHNcIjtcbmV4cG9ydCB0eXBlIHsgR2VuZXJhdG9yUGx1Z2luQ29uZmlnLCBSZXNvbHZlZEdlbmVyYXRvckNvbmZpZyB9IGZyb20gXCIuL3NyYy9jb25maWcudHNcIjtcbmV4cG9ydCB0eXBlIHsgQ3JlYXRlR2VuZXJhdG9yRGFzaGJvYXJkSW5wdXQgfSBmcm9tIFwiLi9zcmMvZGFzaGJvYXJkLnRzXCI7XG5leHBvcnQgeyBCUkFORF9DQUNIRV9UVExfU0VDT05EUywgQlJBTkRfQ0FDSEVfVkVSU0lPTiwgQlJBTkRfR0VORVJBVElPTl9BVFRFTVBUUyB9IGZyb20gXCIuL3NyYy9kZWZhdWx0cy50c1wiO1xuZXhwb3J0IHR5cGUgeyBCcmFuZEV4ZWN1dGVDb25maWcsIEJyYW5kRXhlY3V0aW9uU2V0dGluZ3MgfSBmcm9tIFwiLi9zcmMvZGVmYXVsdHMudHNcIjtcbmV4cG9ydCB7IEJSQU5EX1NZTlRIRVNJU19JTlNUUlVDVElPTlMgfSBmcm9tIFwiLi9zcmMvZ2VuZXJhdGUudHNcIjtcbmV4cG9ydCB0eXBlIHsgQnJhbmRTeW50aGVzaXNJbnB1dCwgQnJhbmRTeW50aGVzaXplciwgR2VuZXJhdGVCcmFuZFBhY2thZ2VPcHRpb25zIH0gZnJvbSBcIi4vc3JjL2dlbmVyYXRlLnRzXCI7XG5leHBvcnQgdHlwZSB7IENyZWF0ZUdlbmVyYXRvckdlbmllSW5wdXQgfSBmcm9tIFwiLi9zcmMvZ2VuaWUudHNcIjtcbmV4cG9ydCB0eXBlIHsgUmVzZWFyY2hLcGlzT3B0aW9ucyB9IGZyb20gXCIuL3NyYy9rcGkudHNcIjtcbmV4cG9ydCB0eXBlIHsgUHJvdmlzaW9uU2NoZW1hSW5wdXQsIEdlbmVyYXRvcklkZW50aXR5IH0gZnJvbSBcIi4vc3JjL25hbWVzcGFjZS50c1wiO1xuZXhwb3J0IHsgR2VuZXJhdG9yT3BlcmF0aW9ucyB9IGZyb20gXCIuL3NyYy9vcGVyYXRpb25zLnRzXCI7XG5leHBvcnQgdHlwZSB7IEdlbmVyYXRvck9wZXJhdGlvbnNPcHRpb25zIH0gZnJvbSBcIi4vc3JjL29wZXJhdGlvbnMudHNcIjtcbmV4cG9ydCB0eXBlIHsgUGxhbkdlbmVyYXRvckRhdGFJbnB1dCB9IGZyb20gXCIuL3NyYy9wbGFuLnRzXCI7XG5leHBvcnQgeyBHZW5lcmF0b3JQbHVnaW4sIGdlbmVyYXRvciB9IGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbmV4cG9ydCB7IERFRkFVTFRfTUFYX1NPVVJDRVMsIERFRkFVTFRfU09VUkNFX01BWF9MRU5HVEgsIE1BWF9TT1VSQ0VTLCBNQVhfU09VUkNFX01BWF9MRU5HVEgsIEFTU0VUX0hUTUxfTUFYX0xFTkdUSCB9IGZyb20gXCIuL3NyYy9yZXNlYXJjaC50c1wiO1xuZXhwb3J0IHR5cGUgeyBCcmFuZFJlc2VhcmNoQ2xpZW50LCBCcmFuZFJlc2VhcmNoT3B0aW9ucywgQnJhbmRQcm9ncmVzc1JlcG9ydGVyLCBCcmFuZFJlc2VhcmNoU291cmNlLCBCcmFuZFJlc2VhcmNoLCBCcmFuZFJlc2VhcmNoVmlzdWFsSW1hZ2UsIEJyYW5kUmVzZWFyY2hWaXN1YWxSZWZlcmVuY2UgfSBmcm9tIFwiLi9zcmMvcmVzZWFyY2gudHNcIjtcbmV4cG9ydCB7IEdFTkVSQVRFX0JSQU5EX1RPT0xfREVTQ1JJUFRJT04sIEdlbmVyYXRlZEJyYW5kUHJvZmlsZVNjaGVtYSB9IGZyb20gXCIuL3NyYy9zY2hlbWEudHNcIjtcbmV4cG9ydCB0eXBlIHsgR2VuZXJhdGVkQnJhbmRQcm9maWxlIH0gZnJvbSBcIi4vc3JjL3NjaGVtYS50c1wiO1xuZXhwb3J0IHR5cGUgeyBTdHJ1Y3R1cmVkR2VuZXJhdGlvbk9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvc3RydWN0dXJlZC50c1wiO1xuZXhwb3J0IHR5cGUgeyBHZW5lcmF0b3JXb3JrZmxvd09wZXJhdGlvbnMsIEdlbmVyYXRvcldvcmtmbG93T3B0aW9ucywgR2VuZXJhdG9yV29ya2Zsb3cgfSBmcm9tIFwiLi9zcmMvd29ya2Zsb3cudHNcIjtcbiJdfQ==

package/lib/src/assets.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Deterministic brand-asset discovery from an official page.
+ *
+ * @module
+ */
+import type { BrandAssetSet } from "@dbx-tools/shared-core/brand-utils";
+/** Asset references extracted from one official HTML page. */
+export interface DiscoveredBrandAssets {
+    /** Theme-aware icon reference. */
+    icon: BrandAssetSet;
+    /** Theme-aware logo reference. */
+    logo: BrandAssetSet;
+    /** Browser favicon reference. */
+    favicon: string;
+}
+/** Visual references extracted from an official mobile-store page. */
+export interface DiscoveredMobileAppVisuals {
+    /** Store listing application name. */
+    appName: string;
+    /** App icon and screenshot URLs in page order. */
+    imageUrls: string[];
+}
+/**
+ * Discover icon, logo, and favicon URLs from an official page.
+ *
+ * The function only returns URLs present in page metadata or markup. When the
+ * page omits an icon, it uses the conventional `/favicon.ico` URL on the same
+ * origin. The logo falls back to that icon so a generated context never points
+ * at the dbx-tools default artwork.
+ */
+export declare function discoverBrandAssets(html: string, pageUrl: string): DiscoveredBrandAssets;
+/** Extract an app name plus representative screenshots/icons from a store page. */
+export declare function discoverMobileAppVisuals(html: string, pageUrl: string): DiscoveredMobileAppVisuals;