@equinor/esv-intersection 3.0.0-beta.1 → 3.0.0-beta.3

package/dist/layers/SchematicLayer.d.ts

@@ -1,7 +1,7 @@
 import { ScaleLinear } from 'd3-scale';
 import { Graphics, Point, Texture } from 'pixi.js';
 import { LayerOptions, PixiLayer, PixiRenderApplication } from '.';
-import { CasingOptions, CementOptions, CementPlugOptions, CementSqueezeOptions, HoleOptions, SchematicData, ScreenOptions, TubingOptions, InternalLayerOptions } from './schematicInterfaces';
+import { CasingOptions, CementOptions, CementPlugOptions, CementSqueezeOptions, HoleOptions, SchematicData, ScreenOptions, TubingOptions, InternalLayerOptions, PerforationOptions } from './schematicInterfaces';
 import { OnUpdateEvent, OnRescaleEvent, OnUnmountEvent } from '../interfaces';
 interface ScalingFactors {
     height: number;
@@ -18,6 +18,7 @@ export interface SchematicLayerOptions<T extends SchematicData> extends LayerOpt
     screenOptions?: ScreenOptions;
     tubingOptions?: TubingOptions;
     cementPlugOptions?: CementPlugOptions;
+    perforationOptions?: PerforationOptions;
 }
 export declare class SchematicLayer<T extends SchematicData> extends PixiLayer<T> {
     private internalLayerVisibility;
@@ -59,6 +60,7 @@ export declare class SchematicLayer<T extends SchematicData> extends PixiLayer<T
     private updateSymbolCache;
     private drawCementPlug;
     private getCementPlugTexture;
+    private createPerforationTexture;
     private prepareSymbolRenderObject;
     private drawSymbolComponent;
     private drawSVGRope;
@@ -81,7 +83,8 @@ export declare class SchematicLayer<T extends SchematicData> extends PixiLayer<T
     private generateShoe;
     private createCementSqueezeShape;
     private getCementTexture;
-    private createCementSqueezeTexture;
+    private createPerforationShape;
+    private getCementSqueezeTexture;
     private drawScreen;
     private drawTubing;
     private getTubingTexture;

package/dist/layers/schematicInterfaces.d.ts

@@ -5,12 +5,10 @@ export interface HoleSize {
     diameter: number;
     start: number;
     end: number;
-    innerDiameter?: number;
 }
 export interface Casing {
     kind: 'casing';
     id: string;
-    casingId: string;
     diameter: number;
     start: number;
     end: number;
@@ -31,19 +29,23 @@ export declare const isPAndASymbol: (item: PAndA) => item is PAndASymbol;
 export interface CementSqueeze {
     kind: 'cementSqueeze';
     id: string;
-    top: number;
-    bottom: number;
-    casingIds?: string[];
+    start: number;
+    end: number;
+    /**
+     * Referenced Casing and Completion ids
+     */
+    referenceIds: string[];
 }
 export declare const isCementSqueeze: (item: PAndA) => item is CementSqueeze;
 export interface CementPlug {
     kind: 'cementPlug';
     id: string;
-    top: number;
-    bottom: number;
-    holeId?: string;
-    casingId?: string;
-    secondCasingId?: string;
+    start: number;
+    end: number;
+    /**
+     * Referenced Casing, Completion ids
+     */
+    referenceIds: string[];
 }
 export declare const isCementPlug: (item: PAndA) => item is CementSqueeze;
 export declare type PAndA = PAndASymbol | CementSqueeze | CementPlug;
@@ -68,9 +70,46 @@ export declare const foldCompletion: <T>(fScreen: (obj: Screen) => T, fTubing: (
 export interface Cement {
     kind: 'cement';
     id: string;
-    casingIds?: string[];
+    /**
+     *  Referenced Casing and Completion ids
+     */
+    referenceIds: string[];
     toc: number;
 }
+/**
+ * 'Open hole' and 'Open hole screen' are not included as they are not visualized and also not included in the ruleset
+ */
+export declare type PerforationSubKind = 'Perforation' | 'Open hole gravel pack' | 'Open hole frac pack' | 'Cased hole frac pack' | 'Cased hole gravel pack' | 'Cased hole fracturation';
+export interface Perforation {
+    kind: 'perforation';
+    subKind: PerforationSubKind;
+    id: string;
+    start: number;
+    end: number;
+    /**
+     * is the perforation open or sealed?
+     */
+    isOpen: boolean;
+    /**
+     * Referenced Casing ids
+     */
+    referenceIds: string[];
+}
+export declare const foldPerforationSubKind: <T>(options: {
+    Perforation: (kind: 'Perforation') => T;
+    OpenHoleGravelPack: (kind: 'Open hole gravel pack') => T;
+    OpenHoleFracPack: (kind: 'Open hole frac pack') => T;
+    CasedHoleGravelPack: (kind: 'Cased hole gravel pack') => T;
+    CasedHoleFracPack: (kind: 'Cased hole frac pack') => T;
+    CasedHoleFracturation: (kind: 'Cased hole fracturation') => T;
+}, subKind: PerforationSubKind) => T;
+export declare const getPerforationsThatStartAtHoleDiameter: (perforations: Perforation[]) => Perforation[];
+export declare const getPerforationsThatSTartAtCasingDiameter: (perforations: Perforation[]) => Perforation[];
+export declare function hasGravelPack(perf: Perforation): boolean;
+export declare function isSubKindPerforation(perf: Perforation): boolean;
+export declare function isSubKindCasedHoleFracPack(perf: Perforation): boolean;
+export declare function isOpenHoleFracPack(perf: Perforation): boolean;
+export declare const intersect: (a: Perforation, b: Perforation) => boolean;
 export interface SchematicData {
     holeSizes: HoleSize[];
     casings: Casing[];
@@ -80,6 +119,7 @@ export interface SchematicData {
     symbols: {
         [key: string]: string;
     };
+    perforations: Perforation[];
 }
 export interface InternalLayerOptions {
     holeLayerId: string;
@@ -87,14 +127,9 @@ export interface InternalLayerOptions {
     completionLayerId: string;
     cementLayerId: string;
     pAndALayerId: string;
+    perforationLayerId: string;
 }
-export declare const defaultInternalLayerOptions: (layerId: string) => {
-    holeLayerId: string;
-    casingLayerId: string;
-    completionLayerId: string;
-    pAndALayerId: string;
-    cementLayerId: string;
-};
+export declare const defaultInternalLayerOptions: (layerId: string) => InternalLayerOptions;
 export interface HoleOptions {
     firstColor: string;
     secondColor: string;
@@ -110,60 +145,47 @@ export interface CasingOptions {
     lineColor: string;
     shoeSize: CasingShoeSize;
 }
-export declare const defaultCasingOptions: {
-    solidColor: string;
-    lineColor: string;
-    shoeSize: {
-        width: number;
-        length: number;
-    };
-};
-export interface CementOptions {
-    firstColor: string;
-    secondColor: string;
+export interface PerforationOptions {
+    stroke: string;
+    yellow: string;
+    grey: string;
+    red: string;
+    transparent: string;
+    spikeWidth: number;
+    packingOpacity: number;
+    fracLineLength: number;
+    fracLineHalfWidth: number;
     scalingFactor: number;
 }
-export declare const defaultCementOptions: {
+export declare const defaultPerforationOptions: PerforationOptions;
+export declare const defaultCasingOptions: CasingOptions;
+export interface CementOptions {
     firstColor: string;
     secondColor: string;
     scalingFactor: number;
-};
+}
+export declare const defaultCementOptions: CementOptions;
 export interface CementSqueezeOptions {
     firstColor: string;
     secondColor: string;
     scalingFactor: number;
 }
-export declare const defaultCementSqueezeOptions: {
-    firstColor: string;
-    secondColor: string;
-    scalingFactor: number;
-};
+export declare const defaultCementSqueezeOptions: CementSqueezeOptions;
 export interface ScreenOptions {
     scalingFactor: number;
     lineColor: string;
 }
-export declare const defaultScreenOptions: {
-    scalingFactor: number;
-    lineColor: string;
-};
+export declare const defaultScreenOptions: ScreenOptions;
 export interface TubingOptions {
     innerColor: string;
     outerColor: string;
     scalingFactor: number;
 }
-export declare const defaultTubingOptions: {
-    scalingFactor: number;
-    innerColor: string;
-    outerColor: string;
-};
+export declare const defaultTubingOptions: TubingOptions;
 export interface CementPlugOptions {
     firstColor: string;
     secondColor: string;
     scalingFactor: number;
 }
-export declare const defaultCementPlugOptions: {
-    firstColor: string;
-    secondColor: string;
-    scalingFactor: number;
-};
+export declare const defaultCementPlugOptions: CementPlugOptions;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/esv-intersection",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.3",
   "description": "Intersection component package with testing and automatic documentation.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",