@malloy-publisher/sdk 0.0.196-dev → 0.0.197-dev

package/src/components/QueryResult/QueryResult.tsx

@@ -16,12 +16,12 @@ interface QueryResultProps {
 
 export function createEmbeddedQueryResult(props: QueryResultProps): string {
    const {
-      projectName: optionalProjectName,
+      environmentName: optionalProjectName,
       packageName: optionalPackageName,
    } = parseResourceUri(props.resourceUri);
    if (!optionalProjectName || !optionalPackageName) {
       throw new Error(
-         "Project and Package name must be provided for query embedding.",
+         "Environment and Package name must be provided for query embedding.",
       );
    }
    return JSON.stringify({
@@ -66,11 +66,11 @@ export default function QueryResult({
    resourceUri,
    height = 400,
 }: QueryResultProps) {
-   const { modelPath, projectName, packageName, versionId } =
+   const { modelPath, environmentName, packageName, versionId } =
       parseResourceUri(resourceUri);
    const { apiClients } = useServer();
 
-   if (!projectName || !packageName) {
+   if (!environmentName || !packageName) {
       throw new Error(
          "No project or package name provided. A resource URI must be provided.",
       );
@@ -80,7 +80,7 @@ export default function QueryResult({
       queryKey: [resourceUri, query, sourceName, queryName],
       queryFn: () =>
          apiClients.models.executeQueryModel(
-            projectName,
+            environmentName,
             packageName,
             modelPath,
             {
@@ -104,7 +104,7 @@ export default function QueryResult({
          )}
          {isError && (
             <ApiErrorDisplay
-               context={`${projectName} > ${packageName} > ${modelPath}`}
+               context={`${environmentName} > ${packageName} > ${modelPath}`}
                error={error}
             />
          )}

package/src/components/ServerProvider.tsx

@@ -4,17 +4,17 @@ import React, {
    createContext,
    ReactNode,
    useContext,
-   useMemo,
    useEffect,
+   useMemo,
    useState,
 } from "react";
 import {
    ConnectionsApi,
    DatabasesApi,
+   EnvironmentsApi,
    ModelsApi,
    NotebooksApi,
    PackagesApi,
-   ProjectsApi,
    PublisherApi,
    WatchModeApi,
 } from "../client";
@@ -52,8 +52,8 @@ export interface ServerProviderProps {
     * Will send "Bearer 123" in the Authorization header.
     */
    getAccessToken?: () => Promise<string>;
-   /** Whether the publisher should allow project and package management operations.
-    * When false, users can only view and explore existing projects and packages.
+   /** Whether the publisher should allow environment and package management operations.
+    * When false, users can only view and explore existing environments and packages.
     * @default true
     */
    mutable?: boolean;
@@ -83,7 +83,7 @@ const getApiClients = (
    return {
       models: new ModelsApi(config, basePath, axiosInstance),
       publisher: new PublisherApi(config, basePath, axiosInstance),
-      projects: new ProjectsApi(config, basePath, axiosInstance),
+      environments: new EnvironmentsApi(config, basePath, axiosInstance),
       packages: new PackagesApi(config, basePath, axiosInstance),
       notebooks: new NotebooksApi(config, basePath, axiosInstance),
       connections: new ConnectionsApi(config, basePath, axiosInstance),

package/src/components/Workbook/ModelPicker.tsx

@@ -32,16 +32,16 @@ export function ModelPicker({
    resourceUri,
 }: ModelPickerProps) {
    const {
-      projectName: projectName,
+      environmentName: environmentName,
       packageName: packageName,
       versionId: versionId,
    } = parseResourceUri(resourceUri);
    const { apiClients } = useServer();
 
    const { data, isLoading, isSuccess, isError, error } = useQueryWithApiError({
-      queryKey: ["models", projectName, packageName, versionId],
+      queryKey: ["models", environmentName, packageName, versionId],
       queryFn: () =>
-         apiClients.models.listModels(projectName, packageName, versionId),
+         apiClients.models.listModels(environmentName, packageName, versionId),
    });
    const [selectedModels, setSelectedModels] = React.useState<string[]>(
       initialSelectedModels || [],
@@ -76,7 +76,7 @@ export function ModelPicker({
       return (
          <ApiErrorDisplay
             error={error}
-            context={`${projectName} > ${packageName} > Model Picker`}
+            context={`${environmentName} > ${packageName} > Model Picker`}
          />
       );
    }

package/src/components/Workbook/Workbook.tsx

@@ -45,7 +45,7 @@ export default function Workbook({ workbookPath, resourceUri }: WorkbookProps) {
    const { server, getAccessToken } = useServer();
    const { apiClients } = useServer();
    const { workbookStorage } = useWorkbookStorage();
-   const { projectName, packageName } = parseResourceUri(resourceUri);
+   const { environmentName, packageName } = parseResourceUri(resourceUri);
    const [success, setSuccess] = React.useState<string | undefined>(undefined);
    const [lastError, setLastError] = React.useState<string | undefined>(
       undefined,
@@ -113,7 +113,7 @@ export default function Workbook({ workbookPath, resourceUri }: WorkbookProps) {
       }
       setDeleteDialogOpen(false);
       // TODO(jjs) - on delete event
-      navigate(`/${projectName}/${packageName}`);
+      navigate(`/${environmentName}/${packageName}`);
    };
 
    const handleDeleteCancel = () => {
@@ -155,7 +155,7 @@ export default function Workbook({ workbookPath, resourceUri }: WorkbookProps) {
                console.log("Fetching model from Publisher", model);
                promises.push(
                   apiClients.models
-                     .getModel(projectName, packageName, model, undefined)
+                     .getModel(environmentName, packageName, model, undefined)
                      .then((data) => ({
                         modelPath: model,
                         sourceInfos: data.data.sourceInfos.map((source) =>
@@ -182,7 +182,7 @@ export default function Workbook({ workbookPath, resourceUri }: WorkbookProps) {
       fetchModels();
       // This function cannot depend on sourceAndPaths because it would cause an infinite loop.
       // eslint-disable-next-line react-hooks/exhaustive-deps
-   }, [getAccessToken, workbookData, packageName, projectName, server]);
+   }, [getAccessToken, workbookData, packageName, environmentName, server]);
 
    React.useEffect(() => {
       if (!workbookPath) {

package/src/components/index.ts

@@ -1,12 +1,12 @@
 export { AnalyzePackageButton } from "./AnalyzePackageButton";
 export { useRouterClickHandler } from "./click_helper";
+export * from "./Environment";
 export * from "./filter";
 export * from "./Home";
 export * from "./Loading";
 export * from "./Model";
 export * from "./Notebook";
 export * from "./Package";
-export * from "./Project";
 export * from "./QueryResult";
 export * from "./RenderedResult";
 export { ServerProvider, useServer } from "./ServerProvider";

package/src/hooks/useDimensionFiltersFromSpec.ts

@@ -10,8 +10,8 @@ import { useDimensionFiltersQuery } from "./useDimensionFiltersQuery";
  * Configuration for dimensional filters
  */
 export interface DimensionFiltersConfig {
-   /** Project name */
-   project: string;
+   /** Environment name */
+   environment: string;
    /** Package name */
    package: string;
    /** Version ID (optional) */
@@ -37,7 +37,7 @@ export interface UseDimensionFiltersFromSpecOptions {
  * Combined hook that manages dimensional filters, data fetching, and query execution
  * from a single configuration object.
  *
- * @param config - Configuration containing project, package, dimension specs, and index limit
+ * @param config - Configuration containing environment, package, dimension specs, and index limit
  * @param queryLimit - Maximum number of results to return from query (default: 100)
  * @returns All state and methods needed for dimensional filtering UI
  */
@@ -69,7 +69,7 @@ export function useDimensionFiltersFromSpec(
    // The hook handles multiple source/model combos internally
    const { data, noRowsMatchedFilter, isLoading, isError, error, refetch } =
       useDimensionalFilterRangeData({
-         project: config.project,
+         environment: config.environment,
          package: config.package,
          indexLimit: config.indexLimit,
          dimensionSpecs: config.dimensionSpecs,
@@ -83,7 +83,7 @@ export function useDimensionFiltersFromSpec(
    // Generate the embedded query result (uses primary source/model)
    const { embeddedQueryResult, queryString, executeQuery, canExecute } =
       useDimensionFiltersQuery({
-         project: config.project,
+         environment: config.environment,
          package: config.package,
          model: primaryModel,
          source: primarySource,

package/src/hooks/useDimensionFiltersQuery.ts

@@ -7,8 +7,8 @@ import { FilterSelection, FilterValuePrimitive } from "./useDimensionFilters";
  * Parameters for the useDimensionFiltersQuery hook
  */
 export interface UseDimensionFiltersQueryParams {
-   /** Project name */
-   project: string;
+   /** Environment name */
+   environment: string;
    /** Package name */
    package: string;
    /** Model path */
@@ -218,7 +218,7 @@ function buildFilteredQuery(
  * });
  *
  * const { embeddedQueryResult, executeQuery, canExecute } = useDimensionFiltersQuery({
- *   project: "my-project",
+ *   environment: "my-environment",
  *   package: "my-package",
  *   model: "model.malloy",
  *   source: "my_source",
@@ -242,7 +242,7 @@ export function useDimensionFiltersQuery(
    params: UseDimensionFiltersQueryParams,
 ): DimensionFiltersQueryResult {
    const {
-      project,
+      environment,
       package: packageName,
       model,
       source,
@@ -266,11 +266,11 @@ export function useDimensionFiltersQuery(
    const resourceUri = useMemo(
       () =>
          encodeResourceUri({
-            projectName: project,
+            environmentName: environment,
             packageName,
             modelPath: model,
          }),
-      [project, packageName, model],
+      [environment, packageName, model],
    );
 
    // Check if query can be executed

package/src/hooks/useDimensionalFilterRangeData.ts

@@ -80,8 +80,8 @@ export type DimensionValues = Map<string, DimensionValue[]>;
  * Parameters for the useDimensionalFilterRangeData hook
  */
 export interface UseDimensionalFilterRangeDataParams {
-   /** Project name */
-   project: string;
+   /** Environment name */
+   environment: string;
    /** Package name */
    package: string;
    /** List of dimension specifications (each includes source and model) */
@@ -611,13 +611,13 @@ function parseIndexQueryResult(
  * The hook groups dimension specs by source/model combination and runs separate
  * index queries for each group, then merges the results.
  *
- * @param params - Parameters including project, package, and dimension specs (each with source/model)
+ * @param params - Parameters including environment, package, and dimension specs (each with source/model)
  * @returns Query result with dimension values map, loading state, and error information
  *
  * @example
  * ```tsx
  * const { data, isLoading, error } = useDimensionalFilterRangeData({
- *   project: "my-project",
+ *   environment: "my-environment",
  *   package: "my-package",
  *   dimensionSpecs: [
  *     { dimensionName: "category", filterType: "Star", source: "my_source", model: "model.malloy" },
@@ -632,7 +632,7 @@ export function useDimensionalFilterRangeData(
    params: UseDimensionalFilterRangeDataParams,
 ): DimensionalFilterRangeDataResult {
    const {
-      project,
+      environment,
       package: packageName,
       dimensionSpecs,
       versionId,
@@ -695,7 +695,7 @@ export function useDimensionalFilterRangeData(
    const queryResult = useQueryWithApiError({
       queryKey: [
          "dimensionalFilter",
-         project,
+         environment,
          packageName,
          dimensionSpecs,
          versionId,
@@ -716,7 +716,7 @@ export function useDimensionalFilterRangeData(
          const results = await Promise.all(
             queryConfigs.map(async (config) => {
                const response = await apiClients.models.executeQueryModel(
-                  project,
+                  environment,
                   packageName,
                   config.model,
                   {

package/src/hooks/useRawQueryData.ts

@@ -19,14 +19,14 @@ export function useRawQueryData({
    enabled = true,
    resourceUri,
 }: UseRawQueryDataProps) {
-   const { projectName, packageName, versionId } =
+   const { environmentName, packageName, versionId } =
       parseResourceUri(resourceUri);
    const { apiClients } = useServer();
 
    const { data, isSuccess, isError, error, isLoading } = useQueryWithApiError({
       queryKey: [
          "rawQueryData",
-         projectName,
+         environmentName,
          packageName,
          modelPath,
          versionId,
@@ -36,7 +36,7 @@ export function useRawQueryData({
       ],
       queryFn: () =>
          apiClients.models.executeQueryModel(
-            projectName,
+            environmentName,
             packageName,
             modelPath,
             {

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from "./components";
-export { default as ConnectionExplorer } from "./components/Project/ConnectionExplorer";
+export { default as ConnectionExplorer } from "./components/Environment/ConnectionExplorer";
 export { useServer } from "./components/ServerProvider";
 export * from "./hooks";
 export { useRawQueryData } from "./hooks/useRawQueryData";

package/src/utils/formatting.spec.ts

@@ -3,10 +3,11 @@ import { encodeResourceUri, parseResourceUri } from "./formatting";
 
 describe("parseResourceUri", () => {
    it("should parse a package URI", () => {
-      const resourceUri = "publisher://projects/malloy-samples/packages/names";
+      const resourceUri =
+         "publisher://environments/malloy-samples/packages/names";
       const parsedResource = parseResourceUri(resourceUri);
       expect(parsedResource).toEqual({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: "names",
          connectionName: undefined,
          modelPath: undefined,
@@ -15,10 +16,10 @@ describe("parseResourceUri", () => {
    });
    it("should parse a connection URI", () => {
       const resourceUri =
-         "publisher://projects/malloy-samples/connections/bigquery";
+         "publisher://environments/malloy-samples/connections/bigquery";
       const parsedResource = parseResourceUri(resourceUri);
       expect(parsedResource).toEqual({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: undefined,
          connectionName: "bigquery",
          modelPath: undefined,
@@ -28,10 +29,10 @@ describe("parseResourceUri", () => {
 
    it("should parse a modelPath URI", () => {
       const resourceUri =
-         "publisher://projects/malloy-samples/packages/names/models/names1.malloynb";
+         "publisher://environments/malloy-samples/packages/names/models/names1.malloynb";
       const parsedResource = parseResourceUri(resourceUri);
       expect(parsedResource).toEqual({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: "names",
          connectionName: undefined,
          modelPath: "names1.malloynb",
@@ -41,13 +42,13 @@ describe("parseResourceUri", () => {
 
    it("should throw an error if the resource URI has the wrong protocol", () => {
       const resourceUri =
-         "http://projects/malloy-samples/packages/names/models/names1.malloynb";
+         "http://environments/malloy-samples/packages/names/models/names1.malloynb";
       expect(() => parseResourceUri(resourceUri)).toThrow(
          `Failed to parse resource URI: ${resourceUri}`,
       );
    });
 
-   it("should throw an error if the resource URI is missing the project name", () => {
+   it("should throw an error if the resource URI is missing the environment name", () => {
       const resourceUri = "publisher://";
       expect(() => parseResourceUri(resourceUri)).toThrow(
          /Failed to parse resource URI/,
@@ -56,10 +57,10 @@ describe("parseResourceUri", () => {
 
    it("should parse the optional versionId parameter if present", () => {
       const resourceUri =
-         "publisher://projects/malloy-samples/packages/names?versionId=1.0.0";
+         "publisher://environments/malloy-samples/packages/names?versionId=1.0.0";
       const parsedResource = parseResourceUri(resourceUri);
       expect(parsedResource).toEqual({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: "names",
          connectionName: undefined,
          modelPath: undefined,
@@ -71,65 +72,65 @@ describe("parseResourceUri", () => {
 describe("encodeResourceUri", () => {
    it("should encode a package URI with no versionId", () => {
       const resourceUri = encodeResourceUri({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: "names",
          connectionName: undefined,
          modelPath: undefined,
          versionId: undefined,
       });
       expect(resourceUri).toEqual(
-         "publisher://projects/malloy-samples/packages/names",
+         "publisher://environments/malloy-samples/packages/names",
       );
    });
 
    it("should encode a package URI with a versionId", () => {
       const resourceUri = encodeResourceUri({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: "names",
          versionId: "1.0.0",
          connectionName: undefined,
          modelPath: undefined,
       });
       expect(resourceUri).toEqual(
-         "publisher://projects/malloy-samples/packages/names?versionId=1.0.0",
+         "publisher://environments/malloy-samples/packages/names?versionId=1.0.0",
       );
    });
 
    it("should encode a connection URI", () => {
       const resourceUri = encodeResourceUri({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: undefined,
          connectionName: "bigquery",
          modelPath: undefined,
          versionId: undefined,
       });
       expect(resourceUri).toEqual(
-         "publisher://projects/malloy-samples/connections/bigquery",
+         "publisher://environments/malloy-samples/connections/bigquery",
       );
    });
 
    it("should encode a modelPath URI", () => {
       const resourceUri = encodeResourceUri({
-         projectName: "malloy-samples",
+         environmentName: "malloy-samples",
          packageName: "names",
          connectionName: undefined,
          modelPath: "names1.malloynb",
          versionId: undefined,
       });
       expect(resourceUri).toEqual(
-         "publisher://projects/malloy-samples/packages/names/models/names1.malloynb",
+         "publisher://environments/malloy-samples/packages/names/models/names1.malloynb",
       );
    });
 
-   it("should throw an error if the resource URI is missing the project name", () => {
+   it("should throw an error if the resource URI is missing the environment name", () => {
       expect(() =>
          encodeResourceUri({
-            projectName: "",
+            environmentName: "",
             packageName: "names",
             connectionName: undefined,
             modelPath: undefined,
             versionId: undefined,
          }),
-      ).toThrow(/Failed to encode resource URI, missing project name/);
+      ).toThrow(/Failed to encode resource URI, missing environment name/);
    });
 });

package/src/utils/formatting.ts

@@ -1,5 +1,5 @@
 export type ParsedResource = {
-   projectName: string;
+   environmentName: string;
    packageName?: string | undefined;
    connectionName?: string | undefined;
    versionId?: string | undefined;
@@ -15,8 +15,9 @@ export const parseResourceUri = (resourceUri: string) => {
    const pathParts = (parsedUri.hostname + parsedUri.pathname).split("/");
    for (let i = 0; i < pathParts.length; i += 2) {
       const part = pathParts[i];
-      if (part === "projects") {
-         parsedResource.projectName = decodeURI(pathParts[i + 1]) || undefined;
+      if (part === "environments") {
+         parsedResource.environmentName =
+            decodeURI(pathParts[i + 1]) || undefined;
       } else if (part === "packages") {
          parsedResource.packageName = decodeURI(pathParts[i + 1]) || undefined;
       } else if (part === "connections") {
@@ -30,19 +31,19 @@ export const parseResourceUri = (resourceUri: string) => {
 
    parsedResource.versionId =
       parsedUri.searchParams.get("versionId") || undefined;
-   if (!parsedResource.projectName) {
+   if (!parsedResource.environmentName) {
       throw new Error(`Failed to parse resource URI: ${resourceUri}`);
    }
    return parsedResource;
 };
 
 export const encodeResourceUri = (resource: ParsedResource) => {
-   if (!resource.projectName) {
+   if (!resource.environmentName) {
       throw new Error(
-         `Failed to encode resource URI, missing project name: ${resource}`,
+         `Failed to encode resource URI, missing environment name: ${resource}`,
       );
    }
-   let uri = `publisher://projects/${resource.projectName}`;
+   let uri = `publisher://environments/${resource.environmentName}`;
    if (resource.packageName) {
       uri += `/packages/${resource.packageName}`;
    }

package/src/utils/parsing.spec.ts

@@ -1,11 +1,15 @@
 import { describe, expect, it } from "bun:test";
-import { getProjectDescription, generateProjectReadme } from "./parsing";
+import {
+   generateEnvironmentReadme,
+   getEnvironmentDescription,
+} from "./parsing";
 
-describe("getProjectDescription", () => {
+describe("getEnvironmentDescription", () => {
    it("should return the first paragraph of the README", () => {
-      const readme = "# Project Description\nThis is a project description";
-      expect(getProjectDescription(readme)).toBe(
-         "Project Description\nThis is a project description",
+      const readme =
+         "# Environment Description\nThis is an environment description";
+      expect(getEnvironmentDescription(readme)).toBe(
+         "Environment Description\nThis is an environment description",
       );
    });
 
@@ -14,42 +18,42 @@ describe("getProjectDescription", () => {
       const readme = `${longDescription}`;
       // 5 characters per word + space, so 20 words = 120 characters
       const truncatedDescription = Array(20).fill("abcde").join(" ") + "...";
-      expect(getProjectDescription(readme)).toBe(truncatedDescription);
+      expect(getEnvironmentDescription(readme)).toBe(truncatedDescription);
    });
 
    it("should return a placeholder description if the README is empty", () => {
       const readme = "";
-      expect(getProjectDescription(readme)).toBe(
+      expect(getEnvironmentDescription(readme)).toBe(
          "Explore semantic models, run queries, and build dashboards",
       );
    });
 });
 
-describe("generateProjectReadme", () => {
+describe("generateEnvironmentReadme", () => {
    it("should preserve the existing readme if it exists", () => {
-      const project = {
-         name: "Test Project",
+      const environment = {
+         name: "Test Environment",
          readme: "# Test Readme",
       };
-      expect(generateProjectReadme(project)).toBe("# Test Readme");
+      expect(generateEnvironmentReadme(environment)).toBe("# Test Readme");
    });
 
-   it("should generate a project readme with the description if it does not exist", () => {
-      const project = {
-         name: "Test Project",
+   it("should generate an environment readme with the description if it does not exist", () => {
+      const environment = {
+         name: "Test Environment",
          readme: "",
       };
-      expect(generateProjectReadme(project, "Test Description")).toBe(
-         "# Test Project\n\nTest Description",
+      expect(generateEnvironmentReadme(environment, "Test Description")).toBe(
+         "# Test Environment\n\nTest Description",
       );
    });
 
    it("should insert the description in the existing readme if both exist", () => {
-      const project = {
-         name: "Test Project",
+      const environment = {
+         name: "Test Environment",
          readme: "# Test Readme\n\nOld Description\n\nMore stuff",
       };
-      expect(generateProjectReadme(project, "New Description")).toBe(
+      expect(generateEnvironmentReadme(environment, "New Description")).toBe(
          "# Test Readme\n\nNew Description\n\nMore stuff",
       );
    });

package/src/utils/parsing.ts

@@ -1,5 +1,7 @@
 // Helper function to extract a brief description from README content
-export const getProjectDescription = (readme: string | undefined): string => {
+export const getEnvironmentDescription = (
+   readme: string | undefined,
+): string => {
    if (!readme) {
       return "Explore semantic models, run queries, and build dashboards";
    }
@@ -28,19 +30,19 @@ export const getProjectDescription = (readme: string | undefined): string => {
    return truncated.join(" ") + "...";
 };
 
-export const generateProjectReadme = (
-   project: {
+export const generateEnvironmentReadme = (
+   environment: {
       name: string;
       readme?: string;
    },
    description?: string,
 ): string => {
-   const readmeLines = (project.readme || undefined)?.split("\n") ?? [];
+   const readmeLines = (environment.readme || undefined)?.split("\n") ?? [];
    if (readmeLines.length === 0) {
-      readmeLines.push(`# ${project.name}`);
+      readmeLines.push(`# ${environment.name}`);
       readmeLines.push("");
    }
-   if ((project.readme?.length ?? 0) > 0 && description) {
+   if ((environment.readme?.length ?? 0) > 0 && description) {
       readmeLines.splice(2, 1, description);
    } else if (description) {
       readmeLines.push(description);