@pine-ds/icons 2.0.1 → 2.0.2

package/dist/types/Users/julian.skinner/kajabi/pine-icons/.stencil/scripts/figma_icons/types.d.ts

@@ -0,0 +1,112 @@
+export interface FigmaIconConfig {
+  /**
+   * Branch that is located in the
+   * Figma file
+   * @example spike-branch
+   */
+  branchName: string;
+  /**
+   * The Personal Acecss Token created
+   * from your Figma Account
+   * @see {@link https://www.figma.com/developers/api#intro:~:text=Access-,tokens,-A%20personal%20access|Figma API}
+   */
+  figmaAccessToken: string;
+  /**
+   * File id
+   * can be located in the url
+   * @example
+   * ```
+   * https://www.figma.com/file/some-unique-id
+   * ```
+   */
+  figmaFileId: string;
+  /**
+   * Frames that will be ignored when
+   * extracting icons
+   * @example
+   * ```json
+   * ignoreFrames: 'Docs'
+   * ```
+   * or
+   * @example
+   * ```json
+   * ignoreFrames: ['Docs', 'Navigation']
+   */
+  ignoreFrames: string[];
+  /**
+   * Path to save the downloaded SVGs
+   */
+  downloadPath: string;
+  /**
+   * Page that contains the icons
+   */
+  pageName: string;
+}
+export type FigmaIcon = {
+  /**
+   * The unique identifier in Figma
+   */
+  id: string;
+  /**
+   * The name of the file stored on disk
+   */
+  filename?: string;
+  /**
+   * The name of the file stored on disk
+   */
+  filesize?: number;
+  /**
+   * The frame the icon is located inside
+   * of Figma
+   *
+   */
+  frame?: string;
+  /**
+   * Name of the component
+   */
+  name: string;
+  /**
+   * Url to download the icon
+   */
+  url?: string;
+  /**
+   * Tags
+   */
+  tags?: string;
+};
+export type IconFileDetail = {
+  /**
+   * The name of the svg file
+   */
+  name: string;
+  /**
+   * The numeric size of the file in kB
+   */
+  size: number;
+};
+export interface SvgDiffResult {
+  /**
+   * The name of the Previous file
+   */
+  previousFileName?: string;
+  /**
+   * The name of the file
+   */
+  filename: string;
+  /**
+   * Git status provided from SimpleGit
+   * Will be 'D', 'M', or ''.
+   * D: Deleted
+   * M: Modified
+   * '': Added
+   */
+  status: string;
+  /**
+   * What the svg content looked like before it was modified or deleted
+   */
+  before: string | null;
+  /**
+   * What the svg content looked like AFTER it was modified or deleted
+   */
+  after: string | null;
+}

package/dist/types/Users/julian.skinner/kajabi/pine-icons/.stencil/scripts/helpers.d.ts

@@ -0,0 +1,55 @@
+export interface SvgData {
+  /**
+   * /dist/svg/airplane-outline.svg
+   */
+  distSvgFilePath: string;
+  /**
+   * airplaneOutline
+   */
+  exportName: string;
+  /**
+   * airplane-outline.svg
+   */
+  fileName: string;
+  /**
+   * airplane-outline.js
+   */
+  fileNameCjs: string;
+  /**
+   * airplane-outline.mjs
+   */
+  fileNameMjs: string;
+  /**
+   * airplane-outline
+   */
+  iconName: string;
+  /**
+   * /dist/pds-icons/svg/airplane-outline.svg
+   */
+  optimizedFilePath: string;
+  /**
+   * The path to the save the optimized SVG within the Repo
+   */
+  optimizedLocalSvgFilePath: string;
+  /**
+   * Optimized svg content data generated from
+   * SVGO
+   */
+  optimizedSvgContent: string;
+  /**
+   * /tmp/svg/airplane-outline.svg
+   */
+  srcFilePath: string;
+  /**
+   * airplane
+   */
+  title: string;
+}
+export interface JsonData {
+  icons: {
+    name: string;
+    tags?: string[];
+  }[];
+  version?: string;
+}
+export declare const reservedKeywords: Set<string>;

package/dist/types/Users/julian.skinner/kajabi/pine-icons/.stencil/scripts/optimize-svgs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Builds the icons for distribution
+ *
+ * @param rootDir - The source directory
+ * @param optimizeeFiles - Flag to indicate if we have files to optimize in `tmp/svg` folder.
+ */
+export declare const run: (rootDir: string, optimizeFiles?: boolean) => Promise<void>;

package/dist/types/components/pds-icon/pds-icon.d.ts

@@ -0,0 +1,37 @@
+export declare class PdsIcon {
+  private io?;
+  private inheritedAttributes;
+  el: HTMLPdsIconElement;
+  private ariaLabel?;
+  private isVisible;
+  private svgContent?;
+  /**
+   *
+   * The color of the icon
+   *
+   */
+  color?: string;
+  /**
+   * The name of the icon to use from
+   * the built-in set.
+   */
+  name?: string;
+  /**
+   * The size of the icon. This can be
+   * 'small', 'regular', 'medium', large, or a
+   * custom value (40px, 1rem, etc)
+   *
+   */
+  size?: 'small' | 'regular' | 'medium' | 'large' | 'auto' | string;
+  private iconSize;
+  componentWillLoad(): void;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  loadIcon(): void;
+  render(): any;
+  /*****
+   * Private Methods
+   ****/
+  private waitUntilVisible;
+  private hasAriaHidden;
+}

package/dist/types/components/pds-icon/request.d.ts

@@ -0,0 +1,2 @@
+export declare const pdsIconContent: Map<string, string>;
+export declare const getSvgContent: (url: string, sanitize?: boolean) => Promise<any>;

package/dist/types/components/pds-icon/utils.d.ts

@@ -0,0 +1,24 @@
+import { PdsIcon } from './pds-icon';
+export declare const addIcons: (icons: {
+  [name: string]: string;
+}) => void;
+export declare const getIconMap: () => Map<string, string>;
+export declare const getName: (iconName: string | undefined) => string;
+export declare const getSrc: (src: string | undefined) => string;
+export declare const getUrl: (icon: PdsIcon) => string;
+export declare const isSrc: (str: string) => boolean;
+export declare const isStr: (val: any) => val is string;
+export declare const toLower: (val: string) => string;
+/**
+ * Elements inside of web components sometimes need to inherit global attributes
+ * set on the host. For example, the inner input in `ion-input` should inherit
+ * the `title` attribute that developers set directly on `ion-input`. This
+ * helper function should be called in componentWillLoad and assigned to a variable
+ * that is later used in the render function.
+ *
+ * This does not need to be reactive as changing attributes on the host element
+ * does not trigger a re-render.
+ */
+export declare const inheritAttributes: (el: HTMLElement, attributes?: string[]) => {
+  [k: string]: any;
+};

package/dist/types/components/pds-icon/validate.d.ts

@@ -0,0 +1,2 @@
+export declare const validateContent: (svgContent: string) => string;
+export declare const isValid: (elm: HTMLElement) => boolean;

package/dist/types/components.d.ts

@@ -0,0 +1,71 @@
+/* eslint-disable */
+/* tslint:disable */
+/**
+ * This is an autogenerated file created by the Stencil compiler.
+ * It contains typing information for all components that exist in this project.
+ */
+import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+export namespace Components {
+    interface PdsIcon {
+        /**
+          * The color of the icon
+         */
+        "color"?: string;
+        /**
+          * The name of the icon to use from the built-in set.
+         */
+        "name"?: string;
+        /**
+          * The size of the icon. This can be 'small', 'regular', 'medium', large, or a custom value (40px, 1rem, etc)
+         */
+        "size"?: | 'small'   // 12px
+    | 'regular'  // 16px
+    | 'medium'  // 20px
+    | 'large'   // 24px
+    | 'auto'
+    | string;
+    }
+}
+declare global {
+    interface HTMLPdsIconElement extends Components.PdsIcon, HTMLStencilElement {
+    }
+    var HTMLPdsIconElement: {
+        prototype: HTMLPdsIconElement;
+        new (): HTMLPdsIconElement;
+    };
+    interface HTMLElementTagNameMap {
+        "pds-icon": HTMLPdsIconElement;
+    }
+}
+declare namespace LocalJSX {
+    interface PdsIcon {
+        /**
+          * The color of the icon
+         */
+        "color"?: string;
+        /**
+          * The name of the icon to use from the built-in set.
+         */
+        "name"?: string;
+        /**
+          * The size of the icon. This can be 'small', 'regular', 'medium', large, or a custom value (40px, 1rem, etc)
+         */
+        "size"?: | 'small'   // 12px
+    | 'regular'  // 16px
+    | 'medium'  // 20px
+    | 'large'   // 24px
+    | 'auto'
+    | string;
+    }
+    interface IntrinsicElements {
+        "pds-icon": PdsIcon;
+    }
+}
+export { LocalJSX as JSX };
+declare module "@stencil/core" {
+    export namespace JSX {
+        interface IntrinsicElements {
+            "pds-icon": LocalJSX.PdsIcon & JSXBase.HTMLAttributes<HTMLPdsIconElement>;
+        }
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { addIcons } from './components/pds-icon/utils';
+export type { Components, JSX } from './components';